@relyio/sdk 0.2.0 → 0.3.0

package/dist/{define-schema-DHvUCKwj.d.cts → define-schema-BD6HSPnG.d.ts}

@@ -1,704 +1,4 @@
-/**
- * Field type definitions matching @relyio/schema package
- */
-/**
- * AI configuration. A single prompt — `instructions` — describes what the
- * element is and how AI should produce its value. Attaches to fields, content
- * types, components, fieldsets, and (extended) asset types.
- *
- * @example
- * ```typescript
- * fields.richText('body', {
- *   ai: {
- *     instructions: `
- *       Write in a conversational tone.
- *       Use short paragraphs (2-3 sentences).
- *       Target grade 8 reading level.
- *     `
- *   }
- * })
- * ```
- */
-interface AIConfig {
-    /**
-     * AI brief for this element: what it should contain and how to produce it.
-     *
-     * Used by the Studio authoring agent and — on asset types with
-     * `ai.autoGenerate` — by the automatic post-upload run.
-     *
-     * The fallback chain for AI guidance is:
-     * 1. ai.instructions (most specific)
-     * 2. ui.description (general field description)
-     * 3. Field displayName + type (inferred from semantics)
-     */
-    instructions?: string;
-}
-/**
- * Field-level AI config. `inputs` names the fields this instruction reads.
- * Unknown ids and cycles are refused when the schema is parsed.
- */
-interface FieldAIConfig extends AIConfig {
-    /** Field ids this instruction reads. Never inferred from instruction text. */
-    inputs?: string[];
-}
-/**
- * Asset-type AI configuration. Extends {@link AIConfig} with `autoGenerate`,
- * the single switch that turns on automatic field generation after upload.
- */
-interface AssetAIConfig extends AIConfig {
-    /**
-     * Master switch for automatic, post-upload field generation. When `true`, the
-     * derived analysis agent fills every field that declares `ai.instructions`,
-     * applied as a review proposal. Only meaningful for image asset types in v1.
-     */
-    autoGenerate?: boolean;
-}
-interface BaseFieldConfig {
-    /** Whether the field is required */
-    required?: boolean;
-    /** Whether the field value must be unique */
-    unique?: boolean;
-    /** Default value for the field */
-    defaultValue?: unknown;
-}
-interface FieldUIConfig {
-    /** Display name shown in the UI */
-    displayName: string;
-    /** Field description/help text */
-    description?: string;
-    /** Widget-specific options */
-    options?: Record<string, unknown>;
-}
-interface RuleCondition {
-    field: string;
-    operator: 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'greater_than' | 'less_than' | 'is_empty' | 'is_not_empty';
-    value?: unknown;
-}
-interface RuleConditions {
-    mode: 'all' | 'any' | 'none';
-    conditions: RuleCondition[];
-}
-interface VisibilityRule {
-    type: 'visibility';
-    action: 'show' | 'hide';
-    conditions: RuleConditions;
-}
-interface RequirementRule {
-    type: 'requirement';
-    action: 'require' | 'optional';
-    conditions: RuleConditions;
-}
-interface ValidationRule {
-    type: 'validation';
-    action: 'validate' | 'skip';
-    message?: string;
-    conditions: RuleConditions;
-}
-interface ReadOnlyRule {
-    type: 'readOnly';
-    action: 'enable' | 'disable';
-    conditions: RuleConditions;
-}
-type FieldRule = VisibilityRule | RequirementRule | ValidationRule | ReadOnlyRule;
-type LocalizationConfig = boolean | string[] | {
-    enabled: boolean;
-    requiredLocales?: string[];
-    fallback?: boolean;
-};
-interface FieldDefinition<TId extends string = string, TType extends string = string, TConfig = unknown> {
-    /** Unique field identifier - preserves literal type for type inference */
-    readonly id: TId;
-    /** Field type */
-    readonly type: TType;
-    /** Type-specific configuration */
-    config?: TConfig;
-    /** UI display configuration */
-    ui?: FieldUIConfig;
-    /** AI configuration: generation/review guidance for this field */
-    ai?: FieldAIConfig;
-    /** Dynamic field rules */
-    rules?: FieldRule[];
-    /** Localization settings */
-    localization?: LocalizationConfig;
-    /** Fallback value when field is empty */
-    fallback?: unknown;
-    /** Whether this field is deprecated */
-    deprecated?: boolean;
-}
-/**
- * Any field definition - used in arrays where we need to preserve specific field types
- */
-type AnyFieldDefinition = FieldDefinition<string, string, unknown>;
-interface ShortTextConfig extends BaseFieldConfig {
-    /** Maximum character length */
-    maxLength?: number;
-    /** Regex pattern for validation */
-    pattern?: string;
-}
-interface LongTextConfig extends BaseFieldConfig {
-    minLength?: number;
-    maxLength?: number;
-}
-interface RichTextConfig extends BaseFieldConfig {
-    /** Maximum character length for the rich text content */
-    maxLength?: number;
-    /** Allowed formatting options (e.g., bold, italic, underline) */
-    allowedFormats?: string[];
-    /** Allowed embed types (e.g., image, video, code) */
-    embedTypes?: string[];
-}
-interface SlugConfig extends BaseFieldConfig {
-    /** Source field to generate slug from */
-    sourceField?: string;
-    /** Maximum character length */
-    maxLength?: number;
-}
-interface UrlConfig extends BaseFieldConfig {
-    /** Allowed URL protocols */
-    allowedProtocols?: ('http' | 'https' | 'ftp' | 'ftps')[];
-    /** Maximum character length */
-    maxLength?: number;
-}
-interface EmailConfig extends BaseFieldConfig {
-    /** Maximum character length */
-    maxLength?: number;
-    /** Whitelist of allowed email domains */
-    domainWhitelist?: string[];
-}
-interface IntegerConfig extends BaseFieldConfig {
-    min?: number;
-    max?: number;
-}
-interface DecimalConfig extends BaseFieldConfig {
-    min?: number;
-    max?: number;
-    decimalPlaces?: number;
-    roundingMode?: 'HALF_UP' | 'FLOOR' | 'CEILING' | 'ROUND' | 'TRUNCATE';
-}
-interface BooleanConfig extends BaseFieldConfig {
-    trueLabel?: string;
-    falseLabel?: string;
-}
-interface EnumConfig extends BaseFieldConfig {
-    options: Array<{
-        value: string;
-        label?: string;
-    }>;
-    multi?: boolean;
-}
-interface DateConfig extends BaseFieldConfig {
-    minDate?: string;
-    maxDate?: string;
-    format?: string;
-}
-interface DateTimeConfig extends BaseFieldConfig {
-    minDateTime?: string;
-    maxDateTime?: string;
-    format?: string;
-    timezone?: boolean;
-}
-interface ReferenceConfig extends BaseFieldConfig {
-    /**
-     * Target entry type id(s) — content type or asset type ids. Pass a single id
-     * for one target or an array for several. All ids must belong to the same
-     * family (all content types or all asset types).
-     */
-    to: string | string[];
-    /** Allow multiple references (the field value is a list). */
-    multi?: boolean;
-    /** Reference strength for publish/unpublish behavior. */
-    referenceStrength?: 'strong' | 'weak';
-    /** Behavior when a referenced entry is deleted. */
-    onTargetDelete?: 'block' | 'nullify';
-}
-interface TagsConfig extends BaseFieldConfig {
-    allowCustom?: boolean;
-    predefinedTags?: string[];
-    maxTags?: number;
-}
-interface ListConfig extends BaseFieldConfig {
-    dragAndDrop?: boolean;
-    minItems?: number;
-    maxItems?: number;
-    /** Subfields for list items */
-    subfields?: FieldDefinition[];
-}
-type FieldType = 'shortText' | 'longText' | 'richText' | 'slug' | 'url' | 'email' | 'integer' | 'decimal' | 'boolean' | 'enum' | 'date' | 'dateTime' | 'reference' | 'tags' | 'list';
-type ComponentFieldType = `component(${string})`;
-type AllFieldTypes = FieldType | ComponentFieldType;
-
-/**
- * Workflow definition for content approval pipelines
- *
- * Workflows define approval stages that content must pass through before
- * publication. They can be configured globally and per content type.
- *
- * @example
- * // Simple workflow with one approval stage
- * const workflow = defineWorkflow({
- *   enabled: true,
- *   stages: [
- *     defineWorkflowStage('review', {
- *       displayName: 'Editorial Review',
- *       allowedRoles: ['editor', 'admin']
- *     })
- *   ]
- * })
- *
- * @example
- * // Multi-stage workflow
- * const workflow = defineWorkflow({
- *   enabled: true,
- *   stages: [
- *     defineWorkflowStage('editorial-review', {
- *       displayName: 'Editorial Review',
- *       allowedRoles: ['editor']
- *     }),
- *     defineWorkflowStage('legal-approval', {
- *       displayName: 'Legal Approval',
- *       requiredApprovals: 1,
- *       allowedRoles: ['legal-reviewer']
- *     }),
- *     defineWorkflowStage('final-approval', {
- *       displayName: 'Final Approval',
- *       requiredApprovals: 2,
- *       allowedRoles: ['publisher', 'admin']
- *     })
- *   ]
- * })
- */
-/**
- * Escalation configuration when a workflow stage times out
- */
-interface WorkflowEscalation {
-    /** Roles to notify when stage times out */
-    notifyRoles?: string[];
-    /** Roles to escalate to if still pending after another timeout period */
-    escalateToRoles?: string[];
-}
-/**
- * Auto-assignment configuration for workflow stages
- */
-interface WorkflowAutoAssign {
-    /** Roles whose users should be notified when content enters this stage */
-    roles: string[];
-}
-/**
- * Workflow stage configuration
- */
-interface WorkflowStageConfig {
-    /** Human-readable name shown in Studio */
-    displayName: string;
-    /** Optional description for reviewers */
-    description?: string;
-    /** Number of approvals needed to pass this stage (default: 1) */
-    requiredApprovals?: number;
-    /** Roles that can approve this stage */
-    allowedRoles?: string[];
-    /** Auto-assignment configuration */
-    autoAssign?: WorkflowAutoAssign;
-    /** Days before escalation triggers (optional) */
-    timeoutDays?: number;
-    /** Escalation configuration when stage times out */
-    escalation?: WorkflowEscalation;
-}
-/**
- * Complete workflow stage definition
- */
-interface WorkflowStageDefinition {
-    readonly _tag: 'workflowStage';
-    readonly id: string;
-    readonly displayName: string;
-    readonly description?: string;
-    readonly requiredApprovals: number;
-    readonly allowedRoles?: string[];
-    readonly autoAssign?: WorkflowAutoAssign;
-    readonly timeoutDays?: number;
-    readonly escalation?: WorkflowEscalation;
-}
-/**
- * Workflow configuration
- */
-interface WorkflowConfig {
-    /** Enable/disable workflow for the branch (default: false) */
-    enabled?: boolean;
-    /** Array of approval stage definitions */
-    stages?: WorkflowStageDefinition[];
-}
-/**
- * Complete workflow definition
- */
-interface WorkflowDefinition {
-    readonly _tag: 'workflow';
-    readonly enabled: boolean;
-    readonly stages: WorkflowStageDefinition[];
-}
-/**
- * Per-content-type workflow configuration
- */
-interface ContentTypeWorkflowConfig {
-    /** Enable workflow for this content type (inherits from global if not set) */
-    enabled?: boolean;
-    /** Which global stages apply to this content type (subset of global stages) */
-    stages?: string[];
-    /** Publish automatically after all stages are approved */
-    autoPublish?: boolean;
-    /** Require all locales to be approved before publishing */
-    requireAllLocales?: boolean;
-}
-/**
- * Define a workflow stage
- *
- * @param id - Unique identifier for the stage (kebab-case or camelCase)
- * @param config - Stage configuration
- *
- * @example
- * const editorialReview = defineWorkflowStage('editorial-review', {
- *   displayName: 'Editorial Review',
- *   description: 'Content quality and style check',
- *   requiredApprovals: 1,
- *   allowedRoles: ['editor', 'senior-editor']
- * })
- *
- * @example
- * // Stage with auto-assignment and timeout
- * const legalApproval = defineWorkflowStage('legal-approval', {
- *   displayName: 'Legal Approval',
- *   allowedRoles: ['legal-reviewer'],
- *   autoAssign: { roles: ['legal-reviewer'] },
- *   timeoutDays: 3,
- *   escalation: {
- *     notifyRoles: ['legal-reviewer'],
- *     escalateToRoles: ['admin']
- *   }
- * })
- */
-declare function defineWorkflowStage(id: string, config: WorkflowStageConfig): WorkflowStageDefinition;
-/**
- * Define a workflow configuration
- *
- * @param config - Workflow configuration with enabled flag and stages
- *
- * @example
- * // Simple workflow
- * const workflow = defineWorkflow({
- *   enabled: true,
- *   stages: [
- *     defineWorkflowStage('review', {
- *       displayName: 'Review',
- *       allowedRoles: ['editor']
- *     })
- *   ]
- * })
- *
- * @example
- * // Disabled workflow (direct publish)
- * const workflow = defineWorkflow({
- *   enabled: false
- * })
- */
-declare function defineWorkflow(config: WorkflowConfig): WorkflowDefinition;
-/**
- * Define content-type specific workflow configuration
- *
- * @param config - Content type workflow configuration
- *
- * @example
- * // Use specific stages from global workflow
- * const blogPostWorkflow = defineContentTypeWorkflow({
- *   enabled: true,
- *   stages: ['editorial-review', 'final-approval'], // Skip legal
- *   autoPublish: false
- * })
- *
- * @example
- * // Disable workflow for this content type
- * const quickUpdateWorkflow = defineContentTypeWorkflow({
- *   enabled: false
- * })
- *
- * @example
- * // Require all locales to be approved
- * const marketingPageWorkflow = defineContentTypeWorkflow({
- *   enabled: true,
- *   stages: ['translation-review', 'regional-approval'],
- *   requireAllLocales: true
- * })
- */
-declare function defineContentTypeWorkflow(config: ContentTypeWorkflowConfig): ContentTypeWorkflowConfig;
-/**
- * Check if a value is a workflow stage definition
- */
-declare function isWorkflowStageDefinition(value: unknown): value is WorkflowStageDefinition;
-/**
- * Check if a value is a workflow definition
- */
-declare function isWorkflowDefinition(value: unknown): value is WorkflowDefinition;
-/**
- * Get all stage IDs from a workflow definition
- */
-declare function getWorkflowStageIds(workflow: WorkflowDefinition): string[];
-/**
- * Find a stage by ID in a workflow definition
- */
-declare function findWorkflowStage(workflow: WorkflowDefinition, stageId: string): WorkflowStageDefinition | undefined;
-/**
- * Get the next stage after a given stage ID (null if last stage)
- */
-declare function getNextWorkflowStage(workflow: WorkflowDefinition, currentStageId: string): WorkflowStageDefinition | null;
-/**
- * Get the first stage in the workflow (null if no stages)
- */
-declare function getFirstWorkflowStage(workflow: WorkflowDefinition): WorkflowStageDefinition | null;
-/**
- * Check if a stage is the final stage in the workflow
- */
-declare function isFinalWorkflowStage(workflow: WorkflowDefinition, stageId: string): boolean;
-/**
- * Convert a workflow definition to JSON-safe format (strips _tag)
- */
-declare function workflowToJSON(workflow: WorkflowDefinition): {
-    enabled: boolean;
-    stages?: Array<Omit<WorkflowStageDefinition, '_tag'>>;
-};
-
-/**
- * Content type definition matching @relyio/schema ContentTypeSchema
- *
- * Uses advanced TypeScript generics to preserve literal field IDs through
- * the type system, enabling full autocomplete in SDK methods like where().
- */
-
-/**
- * Fieldset for organizing related fields
- * Generic over fields to preserve literal field IDs
- */
-interface Fieldset<TFields extends readonly AnyFieldDefinition[] = readonly AnyFieldDefinition[]> {
-    /** Unique fieldset identifier */
-    readonly id: string;
-    /** Display name shown in the UI */
-    readonly displayName: string;
-    /** Optional description */
-    readonly description?: string;
-    /** AI configuration for content generation and review */
-    readonly ai?: AIConfig;
-    /** Fields within this fieldset - preserves literal types */
-    readonly fields: TFields;
-}
-/**
- * Type alias for a fieldset with any fields.
- * Used in generic constraints where we need to accept any fieldset type.
- */
-type AnyFieldset$2 = Fieldset<any>;
-/**
- * Create a fieldset for organizing fields
- * Generic to preserve the specific field types for type inference
- *
- * @example
- * const seoFieldset = fieldset('seo', {
- *   displayName: 'SEO Settings',
- *   fields: [
- *     fields.shortText('metaTitle', { config: { maxLength: 60 } }),
- *     fields.longText('metaDescription', { config: { maxLength: 160 } }),
- *   ]
- * })
- */
-declare function fieldset<TFields extends readonly AnyFieldDefinition[]>(id: string, config: {
-    displayName: string;
-    description?: string;
-    ai?: AIConfig;
-    fields: TFields;
-}): Fieldset<TFields>;
-/**
- * Content type configuration using direct fields
- * Generic to preserve literal field IDs for type inference
- */
-interface ContentTypeConfigWithFields<TFields extends readonly AnyFieldDefinition[] = readonly AnyFieldDefinition[]> {
-    /** Display name shown in the UI */
-    displayName: string;
-    /** Plural display name shown in the UI (e.g., "Products" for "Product") */
-    displayNamePlural?: string;
-    /** Description of the content type */
-    description?: string;
-    /** AI configuration: generation/review guidance */
-    ai?: AIConfig;
-    /**
-     * Field ID to use as entry display title in lists, references, and editor header.
-     * If not set, falls back to: title → name → slug → first shortText field → entryUid
-     */
-    displayField?: string;
-    /** Whether this content type supports hierarchical (parent-child) relationships */
-    hierarchical?: boolean;
-    /** Access tags for role-based access control */
-    accessTags?: string[];
-    /** Workflow configuration for this content type */
-    workflow?: ContentTypeWorkflowConfig;
-    /** Direct field definitions - preserves literal types */
-    fields: TFields;
-    /** Cannot have fieldsets when using fields */
-    fieldsets?: never;
-}
-/**
- * Content type configuration using fieldsets
- * Generic to preserve fieldset field types
- */
-interface ContentTypeConfigWithFieldsets<TFieldsets extends readonly AnyFieldset$2[] = readonly AnyFieldset$2[]> {
-    /** Display name shown in the UI */
-    displayName: string;
-    /** Plural display name shown in the UI (e.g., "Products" for "Product") */
-    displayNamePlural?: string;
-    /** Description of the content type */
-    description?: string;
-    /** AI configuration: generation/review guidance */
-    ai?: AIConfig;
-    /**
-     * Field ID to use as entry display title in lists, references, and editor header.
-     * If not set, falls back to: title → name → slug → first shortText field → entryUid
-     */
-    displayField?: string;
-    /** Access tags for role-based access control */
-    accessTags?: string[];
-    /** Whether this content type supports hierarchical (parent-child) relationships */
-    hierarchical?: boolean;
-    /** Workflow configuration for this content type */
-    workflow?: ContentTypeWorkflowConfig;
-    /** Field organization via fieldsets - preserves literal types */
-    fieldsets: TFieldsets;
-    /** Cannot have direct fields when using fieldsets */
-    fields?: never;
-}
-/**
- * Content type configuration (either fields OR fieldsets, not both)
- */
-type ContentTypeConfig<TFields extends readonly AnyFieldDefinition[] = readonly AnyFieldDefinition[], TFieldsets extends readonly AnyFieldset$2[] = readonly AnyFieldset$2[]> = ContentTypeConfigWithFields<TFields> | ContentTypeConfigWithFieldsets<TFieldsets>;
-/**
- * Content type definition - preserves field types for inference
- */
-interface ContentTypeDefinition<TFields extends readonly AnyFieldDefinition[] = readonly AnyFieldDefinition[], TFieldsets extends readonly AnyFieldset$2[] = readonly AnyFieldset$2[]> {
-    readonly _tag: 'contentType';
-    readonly name: string;
-    readonly displayName: string;
-    readonly displayNamePlural?: string;
-    readonly description?: string;
-    /** AI configuration: generation/review guidance */
-    readonly ai?: AIConfig;
-    /** Field ID to use as entry display title */
-    readonly displayField?: string;
-    readonly hierarchical: boolean;
-    readonly accessTags?: string[];
-    readonly workflow?: ContentTypeWorkflowConfig;
-    readonly fields?: TFields;
-    readonly fieldsets?: TFieldsets;
-}
-/**
- * Define a content type with type-safe fields
- *
- * The generic type parameters preserve the literal field IDs through the type
- * system, enabling autocomplete in SDK methods like where(), select(), etc.
- *
- * @example
- * // Using direct fields
- * const product = defineContentType('product', {
- *   displayName: 'Product',
- *   fields: [
- *     fields.shortText('title', { config: { required: true } }),
- *     fields.currency('price', { config: { currencyCode: 'USD' } }),
- *   ]
- * })
- *
- * @example
- * // Using fieldsets for organization
- * const product = defineContentType('product', {
- *   displayName: 'Product',
- *   fieldsets: [
- *     fieldset('basic', {
- *       displayName: 'Basic Info',
- *       fields: [
- *         fields.shortText('title', { config: { required: true } }),
- *       ]
- *     }),
- *     fieldset('pricing', {
- *       displayName: 'Pricing',
- *       fields: [
- *         fields.currency('price', { config: { currencyCode: 'USD' } }),
- *       ]
- *     }),
- *   ]
- * })
- */
-declare function defineContentType<TFields extends readonly AnyFieldDefinition[], _TFieldsets extends readonly Fieldset<AnyFieldDefinition[]>[]>(name: string, config: ContentTypeConfigWithFields<TFields>): ContentTypeDefinition<TFields, readonly []>;
-declare function defineContentType<_TFields extends readonly AnyFieldDefinition[], TFieldsets extends readonly Fieldset<AnyFieldDefinition[]>[]>(name: string, config: ContentTypeConfigWithFieldsets<TFieldsets>): ContentTypeDefinition<readonly [], TFieldsets>;
-/**
- * Type alias for any content type definition.
- */
-type AnyContentTypeDefinition = ContentTypeDefinition<any, any>;
-/**
- * Extract field IDs from a content type definition
- * Works with both direct fields and fieldsets
- */
-type ExtractFieldIds<T extends AnyContentTypeDefinition> = NonNullable<T['fields']> extends (infer F)[] ? F extends AnyFieldDefinition ? F['id'] : ExtractFromFieldsets<T> : ExtractFromFieldsets<T>;
-type ExtractFromFieldsets<T extends AnyContentTypeDefinition> = NonNullable<T['fieldsets']> extends (infer FS)[] ? FS extends Fieldset<infer Fields> ? Fields extends AnyFieldDefinition[] ? Fields[number]['id'] : never : never : never;
-/**
- * Entry metadata that's present on all content entries
- */
-interface EntryMetadata {
-    /** Unique entry identifier */
-    id: string;
-    /** Content type id (API field name is `type`) */
-    type: string;
-    /** Entry type (content, asset, singleton, settings) */
-    entryType: string;
-    /**
-     * Container lifecycle only (`active` | `archived` | `proposed`).
-     * Publication is `localeStatus` (`INV-LM-STATUS-IS-TWO-FIELDS`).
-     */
-    status: 'active' | 'archived' | 'proposed';
-    /** Per-locale version number */
-    version: number;
-    /** Parent ID for hierarchical content */
-    parentId?: string | null;
-    /** Content locale this payload is reported in */
-    locale: string;
-    /** Publication state of `locale`; absent when that locale has no content of its own. */
-    localeStatus?: 'draft' | 'published' | 'archived';
-    /** Whether `locale` has unpublished changes of its own. */
-    localeHasDraft?: boolean;
-    /** Every locale with unpublished changes, including shared-field drafts. */
-    draftLocales?: string[];
-    /** Whether the shared (non-localized) fields have an unpublished overlay. */
-    hasDraft?: boolean;
-    /** Creation timestamp */
-    createdAt: Date;
-    /** Last update timestamp */
-    updatedAt: Date;
-}
-/**
- * Infer the TypeScript type from a content type definition
- *
- * This extracts all field IDs from the definition and creates a type
- * with those fields as optional properties. Field names will autocomplete
- * in SDK methods like where(), select(), etc.
- *
- * Note: Field values are typed as `unknown`. For full value type inference,
- * use the codegen tool to generate proper types.
- *
- * @example
- * const product = defineContentType('product', {
- *   displayName: 'Product',
- *   fields: [
- *     fields.shortText('title'),
- *     fields.currency('price'),
- *   ]
- * })
- *
- * type Product = InferContentType<typeof product>
- * // { title?: unknown; price?: unknown; _metadata: EntryMetadata }
- */
-type InferContentType<T extends AnyContentTypeDefinition> = {
-    [K in ExtractFieldIds<T> & string]?: unknown;
-} & {
-    _metadata: EntryMetadata;
-};
+import { l as AnyFieldDefinition, w as Fieldset, A as AIConfig, K as LocalePublicationFields, y as ContentTypeConfigWithFields, z as ContentTypeConfigWithFieldsets, c as FieldDefinition, m as AssetAIConfig, a5 as ContentTypeWorkflowConfig, L as LocalizationConfig, H as EntryMetadata, G as ContentTypeDefinition, a4 as WorkflowDefinition } from './define-content-type-CBfnTWSS.js';
 
 /**
  * Singleton content type definition matching @relyio/schema
@@ -754,9 +54,14 @@ declare function defineSingletonContentType<TFields extends readonly AnyFieldDef
 declare function defineSingletonContentType<_TFields extends readonly AnyFieldDefinition[], TFieldsets extends readonly Fieldset<AnyFieldDefinition[]>[]>(name: string, config: ContentTypeConfigWithFieldsets<TFieldsets>): SingletonContentTypeDefinition<readonly [], TFieldsets>;
 declare const defineSingleton: typeof defineSingletonContentType;
 /**
- * Singleton metadata
+ * Singleton metadata.
+ *
+ * The per-locale publication half is inherited from `LocalePublicationFields` rather than absent.
+ * `apps/services/api` reports `localeStatus` / `localeHasDraft` / `draftLocales` on singleton reads
+ * exactly as it does on entry reads (`INV-LM-PUBLICATION-IS-REPORTED-PER-LOCALE`); this type simply
+ * never said so, which told a customer that a singleton has no publication state to read.
  */
-interface SingletonMetadata {
+interface SingletonMetadata extends LocalePublicationFields {
     /** Singleton key identifier */
     key: string;
     /** Singleton type identifier */
@@ -1215,6 +520,10 @@ type InferAssetType<T extends AnyAssetTypeDefinition> = {
  * Query definition matching @relyio/schema QueryDefinitionSchema
  *
  * Queries define predefined API endpoints with filtering, sorting, and caching.
+ *
+ * This is a hand-written mirror: `@relyio/sdk` is published standalone and does not depend on
+ * `@relyio/schema`, so a field added there has to be added here too. When the two drifted, `limit`
+ * was the casualty — the documentation writes `limit: '${limit?20}'` and this file said `number`.
  */
 type WhereOperator = {
     gte?: string | number;
@@ -1257,6 +566,35 @@ type FilterOperator = {
     nin?: string;
 };
 type FilterDefinition = Record<string, string | FilterOperator>;
+/** A value that is either a literal or a `${param}` / `${param?default}` expression. */
+type Parameterizable<T> = T | string;
+type QueryParameterType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
+/**
+ * A declared query parameter.
+ *
+ * Every `${...}` in a query and every `{name}` segment of its endpoint already declares one; this
+ * block adds a type and constraints. Nothing is inferred from a parameter's name.
+ */
+interface QueryParameter {
+    /** The parameter, as it appears in `${...}` or in an endpoint segment */
+    name: string;
+    /** Coerces the caller's value; a value that will not coerce is a 400 */
+    type?: QueryParameterType;
+    /** Overrides what the query's own expressions say */
+    required?: boolean;
+    /** Used when the caller supplies nothing */
+    default?: string | number | boolean | (string | number | boolean)[];
+    minimum?: number;
+    maximum?: number;
+    /** String characters, or array items */
+    minLength?: number;
+    maxLength?: number;
+    /** A regular expression, applied to strings */
+    pattern?: string;
+    enum?: (string | number | boolean)[];
+}
+/** Whether the query answers with one record or a list. Independent of how many rows match. */
+type QueryCardinality = 'one' | 'many';
 type CachePolicyObject = {
     policy: 'public' | 'private' | 'no-cache';
     ttl?: number;
@@ -1279,9 +617,9 @@ interface FetchBlock {
     /** Sort order */
     sort?: SortCondition;
     /** Maximum results */
-    limit?: number;
+    limit?: Parameterizable<number>;
     /** Results offset */
-    offset?: number;
+    offset?: Parameterizable<number>;
 }
 /**
  * Aggregate block - perform aggregations
@@ -1305,7 +643,7 @@ interface AggregateBlock {
     /** Sort order */
     sort?: SortCondition;
     /** Maximum results */
-    limit?: number;
+    limit?: Parameterizable<number>;
 }
 /**
  * Search block - full-text and semantic search
@@ -1339,9 +677,9 @@ interface SearchBlock {
     /** Sort order */
     sort?: SortCondition;
     /** Maximum results */
-    limit?: number;
+    limit?: Parameterizable<number>;
     /** Results offset */
-    offset?: number;
+    offset?: Parameterizable<number>;
 }
 /**
  * Similar block - find similar content via vector search
@@ -1358,7 +696,7 @@ interface SimilarBlock {
     /** Field mapping for results */
     fields?: SelectMapping;
     /** Maximum results */
-    limit?: number;
+    limit?: Parameterizable<number>;
 }
 /**
  * Include sub-queries for additional data
@@ -1367,7 +705,7 @@ interface IncludeSubQuery {
     source: string;
     where?: WhereCondition;
     sort?: SortCondition;
-    limit?: number;
+    limit?: Parameterizable<number>;
     select?: SelectMapping;
 }
 type IncludeSubQueries = Record<string, IncludeSubQuery>;
@@ -1395,6 +733,10 @@ interface QueryConfig {
     select?: SelectMapping;
     /** Cache policy */
     cache?: CachePolicy;
+    /** Types and constraints for the parameters the query already declares by using them */
+    parameters?: QueryParameter[];
+    /** Whether the response is the record itself or a list. Defaults to `many` */
+    cardinality?: QueryCardinality;
 }
 /**
  * Query definition
@@ -1412,6 +754,8 @@ interface QueryDefinition {
     readonly filters?: FilterDefinition;
     readonly select?: SelectMapping;
     readonly cache?: CachePolicy;
+    readonly parameters?: QueryParameter[];
+    readonly cardinality?: QueryCardinality;
 }
 /**
  * Define a predefined query
@@ -1945,10 +1289,6 @@ interface ViewDefinition extends ViewConfig {
     readonly slug: string;
 }
 declare function defineView(id: string, config: ViewConfig): ViewDefinition;
-/**
- * Convert a view definition to JSON format for the schema
- */
-declare function viewToJSON(view: ViewDefinition): object;
 
 /**
  * Schema definition matching @relyio/schema SchemaDefinitionSchema
@@ -2061,13 +1401,6 @@ interface TypedSchemaConfig<TContentTypes extends Record<string, ContentTypeDefi
  * })
  */
 declare function defineSchema<TContentTypes extends Record<string, ContentTypeDefinition>, TComponents extends Record<string, ComponentDefinition> = Record<string, never>, TSingletons extends Record<string, SingletonContentTypeDefinition> = Record<string, never>, TQueries extends Record<string, QueryDefinition> = Record<string, never>, TSettings extends Record<string, SettingsGroupDefinition> = Record<string, never>, TLocales extends readonly LocaleDefinition[] = readonly LocaleDefinition[], TRoles extends readonly RoleDefinition[] = readonly RoleDefinition[], TWorkflow extends WorkflowDefinition | undefined = WorkflowDefinition | undefined, TViews extends readonly ViewDefinition[] = readonly ViewDefinition[], TAssets extends Record<string, AssetTypeDefinition> = Record<string, never>>(config: TypedSchemaConfig<TContentTypes, TComponents, TSingletons, TQueries, TSettings, TLocales, TRoles, TWorkflow, TViews, TAssets>): SchemaDefinition<TContentTypes, TComponents, TSingletons, TQueries, TSettings, TLocales, TRoles, TWorkflow, TViews, TAssets>;
-/**
- * Convert a schema definition to JSON format for the CLI
- *
- * This strips out the _tag properties and converts to the format
- * expected by the RelyIO backend.
- */
-declare function schemaToJSON(schema: SchemaDefinition): object;
 /**
  * Type alias for any schema definition.
  * Uses `any` intentionally for type inference utilities that need to accept any schema.
@@ -2098,4 +1431,4 @@ type SchemaAssetTypeNames<T extends AnySchemaDefinition> = T['assetTypes'] exten
  */
 type SchemaLocaleCodes<T extends AnySchemaDefinition> = T['locales'] extends readonly LocaleDefinition[] ? T['locales'][number]['code'] : never;
 
-export { fieldset as $, type AIConfig as A, type BooleanConfig as B, type ComponentFieldType as C, type DecimalConfig as D, type EmailConfig as E, type FieldUIConfig as F, type SchemaQueryNames as G, type SchemaLocaleCodes as H, type IntegerConfig as I, type SchemaSettingsGroupNames as J, type SchemaAssetTypeNames as K, type LocalizationConfig as L, defineLocale as M, isLocaleDefinition as N, getLocaleCodes as O, findDefaultLocale as P, getActiveLocales as Q, type RichTextConfig as R, type ShortTextConfig as S, type TagsConfig as T, type UrlConfig as U, type ValidationRule as V, buildFallbackChain as W, type TextDirection as X, type LocaleOptions as Y, type LocaleDefinition as Z, defineContentType as _, type FieldAIConfig as a, isWorkflowDefinition as a$, type Fieldset as a0, type ContentTypeConfig as a1, type ContentTypeConfigWithFields as a2, type ContentTypeConfigWithFieldsets as a3, type ContentTypeDefinition as a4, type EntryMetadata as a5, type InferContentType as a6, defineSingletonContentType as a7, defineSingleton as a8, type SingletonContentTypeDefinition as a9, type ImageUploadConfig as aA, type ImageSourceConfig as aB, type ImageExifConfig as aC, type VariantDefinition as aD, type VideoUploadConfig as aE, type VideoPosterConfig as aF, type VideoCaptionsConfig as aG, type VideoDownloadConfig as aH, type VideoWatermarkConfig as aI, type FileUploadConfig as aJ, type FileScanConfig as aK, defineRole as aL, isRoleDefinition as aM, isBuiltInRole as aN, getBuiltInRoleActions as aO, BUILT_IN_ROLES as aP, ROLE_ACTIONS as aQ, BUILT_IN_ROLE_ACTIONS as aR, type BuiltInRole as aS, type RoleAction as aT, type ResourcePermission as aU, type FieldVisibility as aV, type RoleConfig as aW, type RoleDefinition as aX, defineWorkflow as aY, defineWorkflowStage as aZ, defineContentTypeWorkflow as a_, type SingletonMetadata as aa, type InferSingletonContentType as ab, type InferSingleton as ac, defineComponent as ad, type ComponentConfig as ae, type ComponentDefinition as af, type ComponentMetadata as ag, type ComponentReusabilityMetadata as ah, type ComponentValidationMetadata as ai, defineSettingsGroup as aj, type SettingsGroupConfig as ak, type SettingsGroupDefinition as al, type SettingsGroupMetadata as am, type InferSettingsGroup as an, defineAssetType as ao, type AssetTypeConfig as ap, type AssetTypeConfigWithFields as aq, type AssetTypeConfigWithFieldsets as ar, type AssetTypeDefinition as as, type InferAssetType as at, type ImageKindConfig as au, type VideoKindConfig as av, type FileKindConfig as aw, type ImageTransform as ax, type ImageFitMode as ay, type ImageOutputFormat as az, type FieldRule as b, isWorkflowStageDefinition as b0, getWorkflowStageIds as b1, findWorkflowStage as b2, getNextWorkflowStage as b3, getFirstWorkflowStage as b4, isFinalWorkflowStage as b5, workflowToJSON as b6, type WorkflowEscalation as b7, type WorkflowAutoAssign as b8, type WorkflowStageConfig as b9, type WhereOperator as bA, type SortCondition as bB, type SortDirection as bC, type IncludeDefinition as bD, type SelectMapping as bE, type FilterDefinition as bF, type CachePolicy as bG, type CachePolicyObject as bH, type IncludeSubQuery as bI, type IncludeSubQueries as bJ, type InferQueryResponse as bK, type InferQueryParams as bL, type WorkflowStageDefinition as ba, type WorkflowConfig as bb, type WorkflowDefinition as bc, type ContentTypeWorkflowConfig as bd, defineView as be, viewToJSON as bf, type ViewScopeConfig as bg, type ContentTypeScopeConfig as bh, type ContentTypesScopeConfig as bi, type EntryTypeScopeConfig as bj, type AllScopeConfig as bk, type ViewFilterOperator as bl, type ViewFilterCondition as bm, type ViewFilterGroup as bn, type ViewFilter as bo, type ViewConfig as bp, type ViewDefinition as bq, defineQuery as br, type QueryConfig as bs, type QueryDefinition as bt, type FetchBlock as bu, type AggregateBlock as bv, type SearchBlock as bw, type SimilarBlock as bx, type WhereCondition as by, type WhereValue as bz, type FieldDefinition as c, type LongTextConfig as d, type SlugConfig as e, type EnumConfig as f, type DateConfig as g, type DateTimeConfig as h, type ReferenceConfig as i, type ListConfig as j, type AllFieldTypes as k, type AnyFieldDefinition as l, type AssetAIConfig as m, type BaseFieldConfig as n, type FieldType as o, type ReadOnlyRule as p, type RequirementRule as q, type RuleCondition as r, type RuleConditions as s, type VisibilityRule as t, defineSchema as u, schemaToJSON as v, type SchemaConfig as w, type SchemaDefinition as x, type SchemaContentTypeNames as y, type SchemaSingletonNames as z };
+export { type VideoCaptionsConfig as $, type SettingsGroupConfig as A, type SettingsGroupDefinition as B, type ComponentConfig as C, type SettingsGroupMetadata as D, type InferSettingsGroup as E, defineAssetType as F, type AssetTypeConfig as G, type AssetTypeConfigWithFields as H, type InferSingletonContentType as I, type AssetTypeConfigWithFieldsets as J, type AssetTypeDefinition as K, type LocaleOptions as L, type InferAssetType as M, type ImageKindConfig as N, type FileKindConfig as O, type ImageTransform as P, type ImageFitMode as Q, type ImageOutputFormat as R, type SchemaConfig as S, type TextDirection as T, type ImageUploadConfig as U, type VideoKindConfig as V, type ImageSourceConfig as W, type ImageExifConfig as X, type VariantDefinition as Y, type VideoUploadConfig as Z, type VideoPosterConfig as _, type SchemaDefinition as a, type VideoDownloadConfig as a0, type VideoWatermarkConfig as a1, type FileUploadConfig as a2, type FileScanConfig as a3, defineRole as a4, isRoleDefinition as a5, isBuiltInRole as a6, getBuiltInRoleActions as a7, BUILT_IN_ROLES as a8, ROLE_ACTIONS as a9, type WhereCondition as aA, type WhereValue as aB, type WhereOperator as aC, type SortCondition as aD, type SortDirection as aE, type IncludeDefinition as aF, type SelectMapping as aG, type FilterDefinition as aH, type CachePolicy as aI, type CachePolicyObject as aJ, type IncludeSubQuery as aK, type IncludeSubQueries as aL, type Parameterizable as aM, type QueryParameter as aN, type QueryParameterType as aO, type QueryCardinality as aP, type InferQueryResponse as aQ, type InferQueryParams as aR, BUILT_IN_ROLE_ACTIONS as aa, type BuiltInRole as ab, type RoleAction as ac, type ResourcePermission as ad, type FieldVisibility as ae, type RoleConfig as af, type RoleDefinition as ag, defineView as ah, type ViewScopeConfig as ai, type ContentTypeScopeConfig as aj, type ContentTypesScopeConfig as ak, type EntryTypeScopeConfig as al, type AllScopeConfig as am, type ViewFilterOperator as an, type ViewFilterCondition as ao, type ViewFilterGroup as ap, type ViewFilter as aq, type ViewConfig as ar, type ViewDefinition as as, defineQuery as at, type QueryConfig as au, type QueryDefinition as av, type FetchBlock as aw, type AggregateBlock as ax, type SearchBlock as ay, type SimilarBlock as az, type SchemaContentTypeNames as b, type SchemaSingletonNames as c, defineSchema as d, type SchemaQueryNames as e, type SchemaLocaleCodes as f, type SchemaSettingsGroupNames as g, type SchemaAssetTypeNames as h, defineLocale as i, isLocaleDefinition as j, getLocaleCodes as k, findDefaultLocale as l, getActiveLocales as m, buildFallbackChain as n, type LocaleDefinition as o, defineSingletonContentType as p, defineSingleton as q, type SingletonContentTypeDefinition as r, type SingletonMetadata as s, type InferSingleton as t, defineComponent as u, type ComponentDefinition as v, type ComponentMetadata as w, type ComponentReusabilityMetadata as x, type ComponentValidationMetadata as y, defineSettingsGroup as z };