@stndrds/schema 1.0.0-alpha.256 → 1.0.0-alpha.258

package/dist/{attributes-Jji7TfFG.d.mts → attributes-Cmkc7UgJ.d.mts}

@@ -1,4 +1,4 @@
-import { IconName, CountryIso3, CurrencyCode, ColorId, MimeType } from '@stndrds/constants';
+import { IconName, CountryIso3, CurrencyCode, ColorId } from '@stndrds/constants';
 import { Uuid } from './utils.mjs';
 
 type ComputedFormulaAstNode = ComputedFormulaLiteralNode | ComputedFormulaPathNode | ComputedFormulaCallNode | ComputedFormulaBinaryNode;
@@ -100,350 +100,6 @@ interface AutofillConfig {
 declare const AUTOFILL_ELIGIBLE_TYPES: readonly ["text", "number", "checkbox", "date", "phone", "currency", "status", "select", "multiselect"];
 type AutofillEligibleType = (typeof AUTOFILL_ELIGIBLE_TYPES)[number];
 
-interface DocumentLayout {
-    /** Named sub-folders auto-created at the top of the record's drive when first used via attach --variant. */
-    variants?: Record<string, DocumentLayoutVariant>;
-    /** Dev-declared folder structures the user can instantiate via the UI inside a record's drive. */
-    presets?: FolderPreset[];
-}
-interface DocumentLayoutVariant {
-    /** Display title for the auto-created sub-folder. */
-    title: string;
-    description?: string;
-}
-interface FolderPreset {
-    id: string;
-    label: string;
-    icon?: IconName;
-    description?: string;
-    structure: PresetNode[];
-    /** When true, this preset is auto-instantiated on every new record's drive for the owning object. */
-    autoInstantiate?: boolean;
-}
-interface PresetNode {
-    title: string;
-    description?: string;
-    children?: PresetNode[];
-}
-/** Max depth allowed for preset.structure to keep instantiation predictable. */
-declare const MAX_PRESET_DEPTH = 5;
-
-type BuiltInTransform = "toString" | "toNumber" | "toDate" | "toBoolean" | "toISOString";
-type SchemaOperation = {
-    type: "add_attribute";
-    attribute: Attribute;
-} | {
-    type: "remove_attribute";
-    name: string;
-    backup_config: Attribute;
-} | {
-    type: "rename_attribute";
-    from: string;
-    to: string;
-} | {
-    type: "change_type";
-    name: string;
-    from: AttributeType;
-    to: AttributeType;
-    transform?: BuiltInTransform;
-} | {
-    type: "update_config";
-    name: string;
-    from: Partial<Record<string, unknown>>;
-    to: Partial<Record<string, unknown>>;
-} | {
-    type: "remove_object";
-    backup: Record<string, unknown>;
-} | {
-    type: "rename_object";
-    from: string;
-    to: string;
-};
-interface MigrationDefinition {
-    version: number;
-    operations: SchemaOperation[];
-}
-
-/**
- * Timestamps for tracking creation and updates
- */
-interface Timestamps {
-    createdAt: Date;
-    updatedAt: Date;
-}
-/**
- * Object definition - Represents a database table/entity
- */
-interface ObjectDefinition {
-    id?: Uuid;
-    name: string;
-    label: string;
-    pluralLabel?: string;
-    description?: string;
-    icon?: IconName;
-    /**
-     * Template expression used to compute the object's display label.
-     * Supports variable interpolation and pipes for formatting.
-     *
-     * @example
-     * ```typescript
-     * // Simple attribute reference
-     * labelExpression: "{{ name }}"
-     *
-     * // Multiple attributes
-     * labelExpression: "{{ firstName }} {{ lastName }}"
-     *
-     * // With pipes for formatting
-     * labelExpression: "{{ code | UPPER }} - {{ name | capitalize }}"
-     * ```
-     *
-     * Available pipes: UPPER, LOWER, capitalize, trim
-     */
-    labelExpression: string;
-    /**
-     * Optional template expression used to compute the semantic text sent to
-     * Meilisearch for vector generation. When absent, records opt out of semantic
-     * embedding generation.
-     */
-    embeddingExpression?: string;
-    attributes: Attribute[];
-    system?: boolean;
-    /**
-     * If true, no custom (user-created) attributes are allowed on this object.
-     * `standards diff` will report an error if any custom attribute is found.
-     * Use .sealed() on the ObjectBuilder to set this.
-     */
-    sealed?: boolean;
-    /**
-     * List of custom attribute names explicitly acknowledged by the developer.
-     * On a sealed object, these names will NOT trigger a CI failure.
-     * On an extensible object, this is purely documentary.
-     * Use .tolerate(["name"]) on the ObjectBuilder to set this.
-     */
-    toleratedAttributes?: string[];
-    metadata?: Record<string, unknown>;
-    /** Current schema version (incremented with each migration) */
-    schema_version: number;
-    /** Ordered list of migrations applied to this object's schema */
-    migrations: MigrationDefinition[];
-    /** Smart-folder layout convention for documents attached to records of this object. */
-    documentLayout?: DocumentLayout;
-}
-/**
- * Links an attribute to an object
- */
-interface ObjectAttribute {
-    objectId: Uuid;
-    attributeId: Uuid;
-    order?: number;
-    required?: boolean;
-}
-/**
- * Record - Instance of an Object (a row in the database)
- */
-interface ObjectRecord<TValues extends Record<string, unknown> = Record<string, unknown>> extends Timestamps {
-    id: Uuid;
-    objectId: Uuid;
-    /**
-     * Display label computed from the object's labelExpression.
-     * Computed dynamically based on record values.
-     *
-     * @example "John Doe" (from "{{ firstName }} {{ lastName }}")
-     */
-    label: string;
-    /**
-     * Semantic text computed from the object's embeddingExpression and persisted
-     * for Meilisearch documentTemplate-based vector generation.
-     */
-    embeddingText?: string;
-    values: TValues;
-    /** Per-computed-attribute state keyed by attribute name. */
-    computedStates?: Record<string, ComputedAttributeState>;
-    /**
-     * Custom metadata for the record.
-     * Use this for UI/UX state, feature flags, or any application-specific data.
-     * Unlike system fields (id, createdAt, updatedAt), metadata can be updated.
-     */
-    metadata?: Record<string, unknown>;
-    /**
-     * Soft delete timestamp.
-     * If set, the record is considered deleted but can be restored.
-     * Queries exclude soft-deleted records by default.
-     */
-    deletedAt?: Date | null;
-    /**
-     * Actor ID who soft-deleted this record.
-     * Set alongside deletedAt when a record is soft-deleted.
-     */
-    deletedBy?: string | null;
-    /**
-     * Actor ID who created this record.
-     * Automatically set by RecordService when actorId is configured.
-     * Optional for backward compatibility with existing records.
-     */
-    createdBy?: string;
-    /**
-     * Actor ID who last updated this record.
-     * Automatically set by RecordService when actorId is configured.
-     * Optional for backward compatibility with existing records.
-     */
-    lastUpdatedBy?: string;
-    /** Schema version at the time this record was last migrated */
-    schemaVersion: number;
-}
-/**
- * System-managed field names on ObjectRecord.
- * These are stored as SQL columns (not in JSONB `values`).
- *
- * Use this in adapters to determine if a filter/sort attribute is a table column
- * vs. a JSONB value field.
- *
- * @example
- * ```typescript
- * if (SYSTEM_FIELD_NAMES.includes(filter.attribute)) {
- *   // Filter on SQL column (e.g., WHERE created_at > ...)
- * } else {
- *   // Filter on JSONB field (e.g., WHERE values->>'name' = ...)
- * }
- * ```
- */
-declare const SYSTEM_FIELD_NAMES: readonly ["id", "createdAt", "updatedAt", "createdBy", "lastUpdatedBy"];
-/**
- * Type for system field names
- */
-type SystemFieldName = (typeof SYSTEM_FIELD_NAMES)[number];
-/**
- * Reserved attribute names that cannot be used for custom attributes.
- * These names conflict with ObjectRecord properties.
- *
- * Includes:
- * - System fields (id, createdAt, updatedAt, createdBy, lastUpdatedBy)
- * - Other ObjectRecord properties (objectId, label, values, metadata, deletedAt)
- *
- * @example
- * ```typescript
- * if (RESERVED_ATTRIBUTE_NAMES.includes(attributeName)) {
- *   throw new Error(`"${attributeName}" is a reserved name`);
- * }
- * ```
- */
-declare const RESERVED_ATTRIBUTE_NAMES: readonly ["id", "createdAt", "updatedAt", "createdBy", "lastUpdatedBy", "objectId", "label", "embeddingText", "values", "metadata", "deletedAt", "deletedBy", "schemaVersion"];
-/**
- * Type for reserved attribute names
- */
-type ReservedAttributeName = (typeof RESERVED_ATTRIBUTE_NAMES)[number];
-/**
- * Reserved object names that cannot be used for user-created (runtime) objects.
- * These are owned by the framework as sealed system objects.
- */
-declare const RESERVED_OBJECT_NAMES: readonly ["skill"];
-type ReservedObjectName = (typeof RESERVED_OBJECT_NAMES)[number];
-
-type DocumentKind = "file" | "folder";
-interface Document extends Timestamps {
-    id: Uuid;
-    tenantId: Uuid;
-    title: string;
-    kind: DocumentKind;
-    parentId?: Uuid | null;
-    description?: string;
-    contentHash?: string;
-    createdBy?: Uuid;
-    updatedBy?: Uuid;
-    deletedAt?: Date | null;
-    /**
-     * Fractional ordering position within `(tenantId, parentId)`. Lower values
-     * sort first. New rows default to `max(siblings) + 1024` so reorderings can
-     * insert between neighbours without renumbering. The server may rebalance
-     * positions in the background to keep the spacing bounded.
-     */
-    position: number;
-}
-interface DocumentWithSubCount extends Document {
-    subCount: number | null;
-}
-/**
- * Configuration for a single named slot on a DocumentAttribute.
- * Slots are placeholders for files within a Document; declared at design-time
- * on the attribute and validated at attach time.
- */
-interface DocumentSlotConfig {
-    /** Stable identifier referenced in DB. */
-    name: string;
-    /** Display label in UI. Falls back to `name` if absent. */
-    label?: string;
-    /** Description shown to users and to the AI in tool context. */
-    description?: string;
-    /** Surfaced to UI/AI but not enforced by the system. */
-    required?: boolean;
-    /** MIME prefixes or globs (e.g. "image/*", "application/pdf"). */
-    acceptedMimeTypes?: string[];
-    /** Hard ceiling enforced by the service before upload. */
-    maxSizeBytes?: number;
-}
-/** Default applied by the document() builder when no slots are configured. */
-declare const DEFAULT_DOCUMENT_SLOT: DocumentSlotConfig;
-interface DocumentSlot extends Timestamps {
-    id: Uuid;
-    tenantId: Uuid;
-    documentId: Uuid;
-    slotName: string;
-    isAdditional: boolean;
-    fileId: Uuid;
-    status: SlotStatus;
-    ocrText?: string;
-    ocrConfidence?: number;
-    processedAt?: Date;
-}
-type SlotStatus = "uploaded" | "processing" | "completed" | "failed";
-interface CreateDocument {
-    title: string;
-    kind?: DocumentKind;
-    parentId?: Uuid | null;
-    description?: string;
-    position?: number;
-}
-/**
- * Reference to a record attribute that should atomically attach a freshly
- * created Document. Passed alongside `CreateDocument` to make creation
- * link-aware end-to-end (client → REST → service → repo).
- *
- * The server requires this — orphan Documents are not creatable through the
- * REST API.
- */
-interface CreateDocumentLink {
-    objectName: string;
-    sourceRecordId: string;
-    attributeName: string;
-}
-interface UpdateDocument {
-    title?: string;
-    parentId?: Uuid | null;
-    position?: number;
-}
-interface CreateDocumentSlot {
-    documentId: Uuid;
-    slotName: string;
-    fileId: Uuid;
-    isAdditional?: boolean;
-}
-interface UpdateDocumentSlot {
-    status?: SlotStatus;
-    ocrText?: string;
-    ocrConfidence?: number;
-}
-interface DocumentListOptions {
-    limit?: number;
-    offset?: number;
-}
-interface DocumentWithSlots extends Document {
-    slots: DocumentSlot[];
-}
-interface RecordDocuments {
-    /** Documents grouped by attribute name (includes system 'attachments' attribute) */
-    byAttribute: Record<string, DocumentWithSlots[]>;
-}
-
 /**
  * Allowed attribute types in .qualifyWith()
  *
@@ -507,7 +163,7 @@ type OptionPropertyAttribute = SelectAttribute | StatusAttribute | MultiselectAt
  */
 declare function hasOptions(attr: PropertyAttribute): attr is OptionPropertyAttribute;
 
-type AttributeType = "text" | "richtext" | "number" | "checkbox" | "date" | "phone" | "currency" | "status" | "location" | "select" | "multiselect" | "file" | "user" | "relation" | "formula" | "rollup" | "document";
+type AttributeType = "text" | "richtext" | "number" | "checkbox" | "date" | "phone" | "currency" | "status" | "location" | "select" | "multiselect" | "user" | "relation" | "formula" | "rollup" | "document";
 /**
  * Status group categorization
  */
@@ -658,13 +314,6 @@ interface MultiselectAttribute extends BaseAttribute<string[]> {
     options: Option[];
     renderAs?: "badges";
 }
-interface FileAttribute extends BaseAttribute<string> {
-    type: "file";
-    maxFiles?: number;
-    maxSize?: number;
-    allowedTypes?: MimeType[] | readonly MimeType[];
-    multiple?: boolean;
-}
 type UserReferenceType = "user" | "agent";
 interface UserAttribute extends BaseAttribute<string | string[]> {
     type: "user";
@@ -914,17 +563,16 @@ interface RollupAttribute extends Omit<BaseAttribute<never>, "defaultValue" | "r
 /**
  * DocumentAttribute - References structured documents.
  *
- * Unlike FileAttribute which stores raw file references, DocumentAttribute
- * provides structured document handling with typed edge properties.
+ * A DocumentAttribute references packs of anonymous files with typed edge
+ * properties.
  *
- * Every document attribute is multi by construction — the underlying
- * storage (documents + document_slots + files) supports 1 Doc → N slot
- * files uniformly. Single-value file fields use `file()` instead.
+ * Every document attribute is multi by construction — the underlying storage
+ * (documents + files) supports 1 Doc → N files uniformly.
  *
  * @example
  * ```typescript
  * document({ name: "contracts", label: "Contrats" })
- *   .slots([{ name: "signed" }])
+ *   .accepts(["application/pdf"])
  * ```
  */
 interface DocumentAttribute extends BaseAttribute<string[]> {
@@ -935,19 +583,18 @@ interface DocumentAttribute extends BaseAttribute<string[]> {
      * Stored on `record_reference_edges.properties`, not on the document itself.
      */
     properties?: PropertySchema;
-    /**
-     * File slots declared on this attribute. Builder injects
-     * [DEFAULT_DOCUMENT_SLOT] when omitted. Always non-empty in practice.
-     */
-    slots?: DocumentSlotConfig[];
+    /** MIME prefixes/globs (e.g. "image/*", "application/pdf") applied to every file of the pack. */
+    accepts?: string[];
+    /** Hard ceiling in bytes applied to every file of the pack. */
+    maxFileSize?: number;
 }
 /**
  * Union of every attribute definition supported by Standards objects.
  *
  * Use this type when code needs to inspect or render attributes generically
- * across primitive, relation, computed, file, user, and document fields.
+ * across primitive, relation, computed, user, and document fields.
  */
-type Attribute = TextAttribute | RichtextAttribute | NumberAttribute | CheckboxAttribute | DateAttribute | PhoneAttribute | CurrencyAttribute | StatusAttribute | LocationAttribute | SelectAttribute | MultiselectAttribute | FileAttribute | UserAttribute | RelationAttribute | FormulaAttribute | RollupAttribute | DocumentAttribute;
+type Attribute = TextAttribute | RichtextAttribute | NumberAttribute | CheckboxAttribute | DateAttribute | PhoneAttribute | CurrencyAttribute | StatusAttribute | LocationAttribute | SelectAttribute | MultiselectAttribute | UserAttribute | RelationAttribute | FormulaAttribute | RollupAttribute | DocumentAttribute;
 /**
  * Check if an attribute supports sorting based on its type.
  */
@@ -955,4 +602,4 @@ declare function isAttributeSortable(attr: {
     type: AttributeType;
 }): boolean;
 
-export { type ComputedFieldKind as $, type Attribute as A, type TimeFormat as B, type CurrencyAttribute as C, type DateAttribute as D, type Option as E, type FileAttribute as F, type FormulaReturnType as G, type BilateralConfig as H, type RelationTarget as I, type RollupFunction as J, type UserReferenceType as K, type LocationAttribute as L, type MultiRelationAttribute as M, type NumberAttribute as N, type ObjectDefinition as O, type PhoneAttribute as P, type MigrationDefinition as Q, type RelationAttribute as R, type SingleRelationAttribute as S, type TextAttribute as T, type UserAttribute as U, AUTOFILL_ELIGIBLE_TYPES as V, type AttributeGroup as W, type AutofillEligibleType as X, type BaseAttribute as Y, type BuiltInTransform as Z, type ComputedAttributeState as _, type RichtextAttribute as a, type ComputedFormulaBinaryNode as a0, type ComputedFormulaBinaryOperator as a1, type ComputedFormulaCallNode as a2, type ComputedFormulaLiteralNode as a3, ComputedFormulaParseError as a4, type ComputedFormulaPathNode as a5, type ComputedStateStatus as a6, type CreateDocument as a7, type CreateDocumentLink as a8, type CreateDocumentSlot as a9, SYSTEM_FIELD_NAMES as aA, type SlotStatus as aB, type StatusGroup as aC, type SystemFieldName as aD, type UpdateDocument as aE, type UpdateDocumentSlot as aF, hasOptions as aG, inferInverseCardinality as aH, isAttributeSortable as aI, isBilateralRelation as aJ, isUniversalRelation as aK, parseComputedFormula as aL, resolvePropertyDefinitions as aM, DEFAULT_DOCUMENT_SLOT as aa, type DateFormat as ab, type DateValue as ac, type Document as ad, type DocumentKind as ae, type DocumentLayoutVariant as af, type DocumentListOptions as ag, type DocumentSlot as ah, type DocumentWithSlots as ai, type DocumentWithSubCount as aj, type FolderPreset as ak, MAX_PRESET_DEPTH as al, type NumberUnit as am, type ObjectAttribute as an, type ObjectRecord as ao, type OptionPropertyAttribute as ap, type PresetNode as aq, type PropertyAttribute as ar, type PropertyType as as, RELATION_TARGET_ANY as at, RESERVED_ATTRIBUTE_NAMES as au, RESERVED_OBJECT_NAMES as av, type RecordDocuments as aw, type ReservedAttributeName as ax, type ReservedObjectName as ay, type RichTextAttribute as az, type MultiselectAttribute as b, type SelectAttribute as c, type StatusAttribute as d, type FormulaAttribute as e, type RollupAttribute as f, type CheckboxAttribute as g, type ComputedValueType as h, type ComputedReturnType as i, type AttributeType as j, type ComputedOptionsSource as k, type ComputedDependency as l, type ComputedPlan as m, type ComputedFormulaAstNode as n, type DocumentLayout as o, type Timestamps as p, type SchemaOperation as q, type LocationGranularity as r, type Location as s, type DateRangeValue as t, type DocumentAttribute as u, type Phone as v, type Currency as w, type DocumentSlotConfig as x, type PropertySchema as y, type AutofillConfig as z };
+export { type DateFormat as $, type Attribute as A, type BilateralConfig as B, type CurrencyAttribute as C, type DateAttribute as D, type UserReferenceType as E, type FormulaAttribute as F, AUTOFILL_ELIGIBLE_TYPES as G, type AttributeGroup as H, type AutofillEligibleType as I, type BaseAttribute as J, type ComputedFieldKind as K, type LocationAttribute as L, type MultiRelationAttribute as M, type NumberAttribute as N, type Option as O, type PhoneAttribute as P, type ComputedFormulaBinaryNode as Q, type RelationAttribute as R, type SingleRelationAttribute as S, type TextAttribute as T, type UserAttribute as U, type ComputedFormulaBinaryOperator as V, type ComputedFormulaCallNode as W, type ComputedFormulaLiteralNode as X, ComputedFormulaParseError as Y, type ComputedFormulaPathNode as Z, type ComputedStateStatus as _, type RichtextAttribute as a, type DateValue as a0, type NumberUnit as a1, type OptionPropertyAttribute as a2, type PropertyAttribute as a3, type PropertyType as a4, RELATION_TARGET_ANY as a5, type RichTextAttribute as a6, type StatusGroup as a7, hasOptions as a8, inferInverseCardinality as a9, isAttributeSortable as aa, isBilateralRelation as ab, isUniversalRelation as ac, parseComputedFormula as ad, resolvePropertyDefinitions as ae, type MultiselectAttribute as b, type SelectAttribute as c, type StatusAttribute as d, type RollupAttribute as e, type CheckboxAttribute as f, type AttributeType as g, type ComputedAttributeState as h, type ComputedValueType as i, type ComputedReturnType as j, type ComputedOptionsSource as k, type ComputedDependency as l, type ComputedPlan as m, type ComputedFormulaAstNode as n, type LocationGranularity as o, type Location as p, type DateRangeValue as q, type DocumentAttribute as r, type Phone as s, type Currency as t, type PropertySchema as u, type AutofillConfig as v, type TimeFormat as w, type FormulaReturnType as x, type RelationTarget as y, type RollupFunction as z };