@frontera-sdk/functions 1.52.38 → 1.52.40

package/src/types.ts

@@ -412,6 +412,15 @@ export type ActionSubmission = {
   /**
    * The Action's inputs by name. An input that attaches a file accepts one of
    * this run's file inputs as passed in — `{ fileId }`, e.g. `ctx.input.photo`.
+   *
+   * For an Action that changes an existing record, leave out the input named
+   * like the object type's primary key and the `expectedVersion` input: they
+   * are filled from `subjectRef` and `expectedSubjectVersion` (`subjectOf`
+   * gives both). Sent anyway, they must name the same record and version, or
+   * the submission is refused naming the input.
+   *
+   * An input that references another record takes that record's primary key,
+   * as a query row carries it (`'TCH-00026'`, or a UUID).
    */
   input: Record<string, unknown>
   /** Required when the Action's definition says so. */
@@ -736,8 +745,36 @@ export interface BlueprintQueryOptions {
   nearest?: NearestRequest
 }
 
+/**
+ * What the platform attaches to a row it can version: `_meta` on each row of
+ * an editable object type (one whose properties a governed Action may change).
+ */
+export interface BlueprintRecordMeta {
+  /**
+   * The record's edit version — `0` for a record nobody has edited. Send it,
+   * as a string, as an Action's `expectedSubjectVersion`: a submission built
+   * from a stale read then loses instead of overwriting. `subjectOf` does both
+   * halves for you.
+   *
+   * Absent when the row changed while it was being read; read it again.
+   */
+  recordVersion: number
+}
+
 export interface BlueprintQueryResult<T = Record<string, unknown>> {
-  rows: T[]
+  /**
+   * Each row of an editable type carries `_meta: { recordVersion }`. A type
+   * that defines its own `_meta` column keeps its value, and has no version.
+   *
+   * A timestamp property is ISO 8601 text in UTC (`'2026-10-17T09:17:00.000Z'`,
+   * which `new Date()` reads), a date property `'YYYY-MM-DD'`.
+   */
+  rows: Array<T & { _meta?: BlueprintRecordMeta }>
+  /**
+   * The object type's stable id — what `subjectRef.objectTypeId` takes. Present
+   * whenever rows came back.
+   */
+  objectTypeId?: string
   /** True when the query matched more rows than were returned. */
   hasMore: boolean
   /** Present iff `hasMore`. Feed to the next call's `pageToken`.