Skip to content

_index.md

Latest commit

 

History

History
36 lines (28 loc) · 2.23 KB

_index.md

File metadata and controls

36 lines (28 loc) · 2.23 KB
Raw

objectstack-query — Schema References

Auto-generated — do not edit. Maintainers regenerate this in the framework repo with pnpm --filter @objectstack/spec run gen:skill-refs (not runnable in an installed app).

Schemas live in the published @objectstack/spec package. Read them directly from node_modules — there is no local copy in the skill bundle.

Core schemas

  • node_modules/@objectstack/spec/src/data/date-macros.zod.ts — Date Macro Tokens — the declarative placeholders the UI substitutes
  • node_modules/@objectstack/spec/src/data/filter.zod.ts — Unified Query DSL Specification
  • node_modules/@objectstack/spec/src/data/query.zod.ts — QueryAST — Abstract Syntax Tree for data queries.

Transitive dependencies

  • node_modules/@objectstack/spec/src/data/field-value.zod.ts — Field runtime VALUE-shape contract (ADR-0104 D1).
  • node_modules/@objectstack/spec/src/data/field.zod.ts — Exports: FieldType, SelectOptionSchema, LocationCoordinatesSchema, CurrencyConfigSchema, CurrencyValueSchema
  • node_modules/@objectstack/spec/src/kernel/metadata-protection.zod.ts — Metadata Protection Model — Phase 1 (ADR-0010)
  • node_modules/@objectstack/spec/src/shared/expression.zod.ts — Expression Protocol
  • node_modules/@objectstack/spec/src/shared/identifiers.zod.ts — Exports: SystemIdentifierSchema, SnakeCaseIdentifierSchema, MetadataItemNameSchema
  • node_modules/@objectstack/spec/src/shared/suggestions.zod.ts — "Did you mean?" Suggestion Utilities
  • node_modules/@objectstack/spec/src/shared/value-domain.zod.ts — Standard value domains: one closed vocabulary and one membership predicate for settings and fields.

How to read these

  1. The schemas are runtime Zod definitions. Use Read on the absolute path under node_modules/@objectstack/spec/src/ to inspect field shapes, .describe() text, enums, and refinements.
  2. TypeScript types: import type { … } from '@objectstack/spec' (or the matching subpath export).
  3. Runtime values: import from the matching subpath shown in the schema's directory ('@objectstack/spec/data', '@objectstack/spec/ai', …). The root barrel re-exports the common factories, but not every symbol — when in doubt, use the subpath.