@elaraai/e3-types 1.0.84 → 1.0.86

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/dist/src/api.d.ts +523 -17
  2. package/dist/src/api.d.ts.map +1 -1
  3. package/dist/src/api.js +208 -22
  4. package/dist/src/api.js.map +1 -1
  5. package/dist/src/dataflow.d.ts +115 -12
  6. package/dist/src/dataflow.d.ts.map +1 -1
  7. package/dist/src/dataflow.js +151 -15
  8. package/dist/src/dataflow.js.map +1 -1
  9. package/dist/src/dataflow.spec.js +41 -7
  10. package/dist/src/dataflow.spec.js.map +1 -1
  11. package/dist/src/dataset-blob.d.ts +19 -2
  12. package/dist/src/dataset-blob.d.ts.map +1 -1
  13. package/dist/src/dataset-blob.js +100 -21
  14. package/dist/src/dataset-blob.js.map +1 -1
  15. package/dist/src/dataset-blob.spec.js +132 -0
  16. package/dist/src/dataset-blob.spec.js.map +1 -1
  17. package/dist/src/execution.d.ts +68 -8
  18. package/dist/src/execution.d.ts.map +1 -1
  19. package/dist/src/execution.js +49 -8
  20. package/dist/src/execution.js.map +1 -1
  21. package/dist/src/execution.spec.js +31 -9
  22. package/dist/src/execution.spec.js.map +1 -1
  23. package/dist/src/index.d.ts +8 -7
  24. package/dist/src/index.d.ts.map +1 -1
  25. package/dist/src/index.js +14 -11
  26. package/dist/src/index.js.map +1 -1
  27. package/dist/src/names.d.ts +9 -0
  28. package/dist/src/names.d.ts.map +1 -1
  29. package/dist/src/names.js.map +1 -1
  30. package/dist/src/pieces.d.ts +47 -0
  31. package/dist/src/pieces.d.ts.map +1 -0
  32. package/dist/src/pieces.js +17 -0
  33. package/dist/src/pieces.js.map +1 -0
  34. package/dist/src/pieces.spec.d.ts +6 -0
  35. package/dist/src/pieces.spec.d.ts.map +1 -0
  36. package/dist/src/pieces.spec.js +20 -0
  37. package/dist/src/pieces.spec.js.map +1 -0
  38. package/dist/src/release.d.ts +1 -1
  39. package/dist/src/release.js +1 -1
  40. package/dist/src/repository.d.ts +16 -0
  41. package/dist/src/repository.d.ts.map +1 -1
  42. package/dist/src/repository.js +15 -0
  43. package/dist/src/repository.js.map +1 -1
  44. package/dist/src/structure.d.ts +27 -0
  45. package/dist/src/structure.d.ts.map +1 -1
  46. package/dist/src/structure.js +59 -18
  47. package/dist/src/structure.js.map +1 -1
  48. package/dist/src/structure.spec.d.ts +6 -0
  49. package/dist/src/structure.spec.d.ts.map +1 -0
  50. package/dist/src/structure.spec.js +57 -0
  51. package/dist/src/structure.spec.js.map +1 -0
  52. package/package.json +3 -2
  53. package/src/api.ts +225 -21
  54. package/src/dataflow.spec.ts +49 -7
  55. package/src/dataflow.ts +160 -14
  56. package/src/dataset-blob.spec.ts +147 -0
  57. package/src/dataset-blob.ts +97 -20
  58. package/src/execution.spec.ts +31 -9
  59. package/src/execution.ts +52 -7
  60. package/src/index.ts +38 -2
  61. package/src/names.ts +12 -0
  62. package/src/pieces.spec.ts +23 -0
  63. package/src/pieces.ts +49 -0
  64. package/src/release.ts +1 -1
  65. package/src/repository.ts +18 -0
  66. package/src/structure.spec.ts +65 -0
  67. package/src/structure.ts +64 -21
package/dist/src/api.d.ts CHANGED
@@ -1012,6 +1012,9 @@ export declare const DatasetStatusInfoType: StructType<{
1012
1012
  * @property peakBytes - The highest peak resident memory, in bytes, a runner
1013
1013
  * of the execution the status comes from reached: the one the output came
1014
1014
  * from, or the failure; `none` when it recorded none, or while it runs
1015
+ * @property stopped - Why the latest attempt over the task's current inputs
1016
+ * stopped, when it was cancelled or interrupted and the task therefore reads
1017
+ * `ready`; `none` otherwise
1015
1018
  */
1016
1019
  export declare const TaskStatusInfoType: StructType<{
1017
1020
  readonly name: StringType;
@@ -1053,6 +1056,16 @@ export declare const TaskStatusInfoType: StructType<{
1053
1056
  readonly output: StringType;
1054
1057
  readonly dependsOn: ArrayType<StringType>;
1055
1058
  readonly peakBytes: OptionType<IntegerType>;
1059
+ readonly stopped: OptionType<StructType<{
1060
+ readonly kind: VariantType<{
1061
+ readonly aborted: NullType;
1062
+ readonly yielded: NullType;
1063
+ readonly owner_gone: NullType;
1064
+ readonly host: StringType;
1065
+ readonly unrecorded: NullType;
1066
+ }>;
1067
+ readonly message: StringType;
1068
+ }>>;
1056
1069
  }>;
1057
1070
  /**
1058
1071
  * Summary counts for workspace status.
@@ -1145,6 +1158,16 @@ export declare const WorkspaceStatusResultType: StructType<{
1145
1158
  readonly output: StringType;
1146
1159
  readonly dependsOn: ArrayType<StringType>;
1147
1160
  readonly peakBytes: OptionType<IntegerType>;
1161
+ readonly stopped: OptionType<StructType<{
1162
+ readonly kind: VariantType<{
1163
+ readonly aborted: NullType;
1164
+ readonly yielded: NullType;
1165
+ readonly owner_gone: NullType;
1166
+ readonly host: StringType;
1167
+ readonly unrecorded: NullType;
1168
+ }>;
1169
+ readonly message: StringType;
1170
+ }>>;
1148
1171
  }>>;
1149
1172
  readonly summary: StructType<{
1150
1173
  /** Dataset status counts */
@@ -1283,11 +1306,19 @@ export declare const TaskDetailsType: StructType<{
1283
1306
  * Request to start dataflow execution. The run takes the server's budget of
1284
1307
  * cores and memory, which it shares with everything else the server runs.
1285
1308
  *
1286
- * @property force - Force re-execution of all tasks
1287
- * @property filter - Filter to specific task names (glob pattern)
1309
+ * @property force - The tasks the run re-executes even where the cache holds
1310
+ * their results: none, all, or the tasks named ({@link DataflowForceType}).
1311
+ * A start naming a task the graph does not have, or one the filter's run set
1312
+ * leaves out, is refused before anything runs.
1313
+ * @property filter - One task's exact name: the run runs that task and its
1314
+ * dependency closure, and no other task
1288
1315
  */
1289
1316
  export declare const DataflowRequestType: StructType<{
1290
- readonly force: BooleanType;
1317
+ readonly force: VariantType<{
1318
+ readonly none: NullType;
1319
+ readonly all: NullType;
1320
+ readonly tasks: ArrayType<StringType>;
1321
+ }>;
1291
1322
  readonly filter: OptionType<StringType>;
1292
1323
  }>;
1293
1324
  /**
@@ -1306,6 +1337,28 @@ export declare const LogChunkType: StructType<{
1306
1337
  readonly totalSize: IntegerType;
1307
1338
  readonly complete: BooleanType;
1308
1339
  }>;
1340
+ /**
1341
+ * Chunk of a task's log, as the logs route serves it: a {@link LogChunkType}'s
1342
+ * fields, and the execution it was read from. A client polling the log reads
1343
+ * on from its offset, starts over when the execution changes, and stops
1344
+ * reading once the execution has ended and its log is read.
1345
+ *
1346
+ * @property inputsHash - The execution's inputs hash, which a request names,
1347
+ * with its id, to read on from the same execution
1348
+ * @property executionId - The execution's id
1349
+ * @property ended - True once the execution is recorded as anything but
1350
+ * running: its log grows no more
1351
+ */
1352
+ export declare const TaskLogChunkType: StructType<{
1353
+ readonly data: StringType;
1354
+ readonly offset: IntegerType;
1355
+ readonly size: IntegerType;
1356
+ readonly totalSize: IntegerType;
1357
+ readonly complete: BooleanType;
1358
+ readonly inputsHash: StringType;
1359
+ readonly executionId: StringType;
1360
+ readonly ended: BooleanType;
1361
+ }>;
1309
1362
  /**
1310
1363
  * Result of executing a single task.
1311
1364
  *
@@ -1520,12 +1573,32 @@ export declare const SplitProgressType: StructType<{
1520
1573
  * DataflowExecutionStateType in dataflow.ts which stores the full
1521
1574
  * execution state on disk.
1522
1575
  *
1576
+ * A poll names a cursor (`since`), the sequence number of the last event it
1577
+ * has, and is served the run's events past it, at most its `limit`, and never
1578
+ * more than {@link DATAFLOW_POLL_EVENTS_MAX}; the response's `nextSeq` is the
1579
+ * cursor of the poll after it. A poll that has every event reads no event of
1580
+ * the run, so a client polls on a timer for the whole run at the cost of what
1581
+ * is new.
1582
+ *
1583
+ * The response names the run (`runId`) and where its events end (`lastSeq`).
1584
+ * A cursor counts a run's own events, so a client that sees another run starts
1585
+ * from 0. A poll whose `nextSeq` is before `lastSeq` left events for the next,
1586
+ * which a client reads before it takes a run's end as its last word; and a
1587
+ * client opens a running run's feed near its tail from `lastSeq`, or follows
1588
+ * its progress with polls that ask for no events (`limit` 0).
1589
+ *
1590
+ * @property runId - The run's id, a UUIDv7
1523
1591
  * @property status - Current execution status
1524
1592
  * @property startedAt - ISO timestamp when execution started
1525
1593
  * @property completedAt - ISO timestamp when execution finished (if done)
1526
1594
  * @property summary - Execution summary (available when complete)
1527
- * @property events - Task events (may be paginated via offset/limit)
1528
- * @property totalEvents - Total number of events (for pagination)
1595
+ * @property events - The run's task events past the poll's cursor, at most
1596
+ * its limit, in the order they happened
1597
+ * @property nextSeq - The cursor past the events served, which the next poll
1598
+ * passes as `since`: the poll's own when it served none
1599
+ * @property lastSeq - The sequence number of the run's last event when the
1600
+ * poll read it, 0 while it has none: the cursor of a poll that has every
1601
+ * event
1529
1602
  * @property budget - The server's budget now, where it has one: a server whose
1530
1603
  * runners hold none, as a remote backend's, serves `none`
1531
1604
  * @property waiting - The tasks and units of the run waiting for room, while it
@@ -1534,6 +1607,7 @@ export declare const SplitProgressType: StructType<{
1534
1607
  * stores it
1535
1608
  */
1536
1609
  export declare const ApiDataflowExecutionStateType: StructType<{
1610
+ readonly runId: StringType;
1537
1611
  readonly status: VariantType<{
1538
1612
  readonly running: NullType;
1539
1613
  readonly completed: NullType;
@@ -1600,7 +1674,8 @@ export declare const ApiDataflowExecutionStateType: StructType<{
1600
1674
  readonly reserves: IntegerType;
1601
1675
  }>;
1602
1676
  }>>;
1603
- readonly totalEvents: IntegerType;
1677
+ readonly nextSeq: IntegerType;
1678
+ readonly lastSeq: IntegerType;
1604
1679
  readonly budget: OptionType<StructType<{
1605
1680
  readonly cores: IntegerType;
1606
1681
  readonly memory: IntegerType;
@@ -1630,10 +1705,18 @@ export declare const ApiDataflowExecutionStateType: StructType<{
1630
1705
  readonly units: IntegerType;
1631
1706
  }>>;
1632
1707
  }>;
1708
+ /**
1709
+ * The most events a poll of a run is served ({@link ApiDataflowExecutionStateType}):
1710
+ * a poll that names no `limit`, or a larger one, is served this many, so an
1711
+ * answer stays within what a host's response may hold however long the run. A
1712
+ * client reads on from the answer's `nextSeq`.
1713
+ */
1714
+ export declare const DATAFLOW_POLL_EVENTS_MAX = 1000;
1633
1715
  /**
1634
1716
  * Execution status for history listing: `cancelled` when e3 stopped the
1635
- * execution because its run was aborted, `interrupted` when the orchestrator
1636
- * that owned it exited before it finished.
1717
+ * execution because the signal it ran under was aborted, `interrupted` when
1718
+ * it can no longer finish — its runner and its owner are gone, its host says
1719
+ * so, or its run yielded mid-stage. Each says why in its item's `reason`.
1637
1720
  */
1638
1721
  export declare const ExecutionHistoryStatusType: VariantType<{
1639
1722
  readonly running: NullType;
@@ -1644,9 +1727,12 @@ export declare const ExecutionHistoryStatusType: VariantType<{
1644
1727
  readonly interrupted: NullType;
1645
1728
  }>;
1646
1729
  /**
1647
- * A single execution in task history.
1730
+ * A single execution in task history: a run of the task, never a split task's
1731
+ * unit. The history lists them the latest first, a page at a time.
1648
1732
  *
1649
1733
  * @property inputsHash - Hash of concatenated inputs (execution identifier)
1734
+ * @property executionId - The run's id, a UUIDv7: the next page is the runs
1735
+ * before the last one's
1650
1736
  * @property inputHashes - Individual input object hashes
1651
1737
  * @property status - Execution outcome
1652
1738
  * @property startedAt - ISO timestamp when execution started
@@ -1655,9 +1741,11 @@ export declare const ExecutionHistoryStatusType: VariantType<{
1655
1741
  * @property exitCode - Process exit code (if failed)
1656
1742
  * @property peakBytes - The highest peak resident memory, in bytes, a runner
1657
1743
  * of the execution reached, when it succeeded or failed and one reported it
1744
+ * @property reason - Why it stopped, when it was cancelled or interrupted
1658
1745
  */
1659
1746
  export declare const ExecutionListItemType: StructType<{
1660
1747
  readonly inputsHash: StringType;
1748
+ readonly executionId: StringType;
1661
1749
  readonly inputHashes: ArrayType<StringType>;
1662
1750
  readonly status: VariantType<{
1663
1751
  readonly running: NullType;
@@ -1672,7 +1760,29 @@ export declare const ExecutionListItemType: StructType<{
1672
1760
  readonly duration: OptionType<IntegerType>;
1673
1761
  readonly exitCode: OptionType<IntegerType>;
1674
1762
  readonly peakBytes: OptionType<IntegerType>;
1763
+ readonly reason: OptionType<StructType<{
1764
+ readonly kind: VariantType<{
1765
+ readonly aborted: NullType;
1766
+ readonly yielded: NullType;
1767
+ readonly owner_gone: NullType;
1768
+ readonly host: StringType;
1769
+ readonly unrecorded: NullType;
1770
+ }>;
1771
+ readonly message: StringType;
1772
+ }>>;
1675
1773
  }>;
1774
+ /**
1775
+ * The runs a page of a task's history holds when its request names no
1776
+ * `limit`.
1777
+ */
1778
+ export declare const TASK_EXECUTIONS_PAGE_DEFAULT = 100;
1779
+ /**
1780
+ * The most runs a page of a task's history holds ({@link ExecutionListItemType}):
1781
+ * a request naming a larger `limit` is served this many, so a page stays
1782
+ * within what a host's response may hold. A client reads on with the last
1783
+ * run's id as `before`.
1784
+ */
1785
+ export declare const TASK_EXECUTIONS_PAGE_MAX = 1000;
1676
1786
  /**
1677
1787
  * Tree branch kind variant.
1678
1788
  *
@@ -1839,8 +1949,8 @@ export declare const DiagnosticType: StructType<{
1839
1949
  *
1840
1950
  * `inputs` names what the call read: each dataset argument's path and the hash
1841
1951
  * it was pinned at, in argument order, so an answer can be reproduced and a
1842
- * stale one noticed. It is empty for a named function call, for a one-shot
1843
- * with value arguments only, and for an `invalid` result.
1952
+ * stale one noticed. It is empty for a call with value arguments only, and for
1953
+ * an `invalid` result.
1844
1954
  */
1845
1955
  export declare const ExecuteResultType: StructType<{
1846
1956
  readonly outcome: VariantType<{
@@ -1877,9 +1987,30 @@ export declare const ExecuteResultType: StructType<{
1877
1987
  readonly hash: StringType;
1878
1988
  }>>;
1879
1989
  }>;
1880
- /** Named function call. Positional args, one beast2-encoded value per param. */
1990
+ /**
1991
+ * A call's argument: a beast2-encoded value, or a dataset of the workspace the
1992
+ * call runs in, resolved and pinned by its content hash at launch and named in
1993
+ * the result's `inputs`. A named function call and a one-shot take it alike.
1994
+ */
1995
+ export declare const CallArgType: VariantType<{
1996
+ readonly value: BlobType;
1997
+ readonly dataset: ArrayType<VariantType<{
1998
+ readonly field: StringType;
1999
+ }>>;
2000
+ }>;
2001
+ /**
2002
+ * Named function call. Positional args, one per param: a value, or a dataset
2003
+ * of the workspace ({@link CallArgType}). The package-scoped route has no
2004
+ * workspace to read a dataset from, and answers a dataset argument `invalid`;
2005
+ * the workspace-scoped route pins it, as a one-shot's is.
2006
+ */
1881
2007
  export declare const FunctionCallRequestType: StructType<{
1882
- readonly args: ArrayType<BlobType>;
2008
+ readonly args: ArrayType<VariantType<{
2009
+ readonly value: BlobType;
2010
+ readonly dataset: ArrayType<VariantType<{
2011
+ readonly field: StringType;
2012
+ }>>;
2013
+ }>>;
1883
2014
  readonly runner: OptionType<VariantType<{
1884
2015
  readonly east_node: StructType<{
1885
2016
  readonly platforms: ArrayType<StringType>;
@@ -2309,10 +2440,25 @@ export declare const MutationResultType: StructType<{
2309
2440
  }>;
2310
2441
  }>;
2311
2442
  }>;
2443
+ /**
2444
+ * When a record applied one step of its migration chain.
2445
+ *
2446
+ * @property at - When the step was applied: the time of the deploy that
2447
+ * applied it; `none` for a step a record applied before e3 kept the time
2448
+ * @property commit - The commit that applied it: its `$migrate:<name>` commit,
2449
+ * or the `$init` or `$reset` commit that counted the chain applied; `none`
2450
+ * once a compaction has cut it from the chain, or for a step a record applied
2451
+ * before e3 kept it
2452
+ */
2453
+ export declare const RecordMigrationAppliedType: StructType<{
2454
+ readonly at: OptionType<DateTimeType>;
2455
+ readonly commit: OptionType<StringType>;
2456
+ }>;
2312
2457
  /**
2313
2458
  * A record's callable surface, returned by `describe` so dynamic callers can
2314
- * encode mutation arguments and read through its indexes. The mutation
2315
- * `argTypes` are the EXTRA parameters after the implicit current state.
2459
+ * encode mutation arguments and read through its indexes, and a console can
2460
+ * show the record whole without reading its history. The mutation `argTypes`
2461
+ * are the EXTRA parameters after the implicit current state.
2316
2462
  */
2317
2463
  export declare const RecordSignatureType: StructType<{
2318
2464
  readonly name: StringType;
@@ -2459,6 +2605,111 @@ export declare const RecordSignatureType: StructType<{
2459
2605
  }>>;
2460
2606
  /** Whether a row may hold several index keys. */
2461
2607
  readonly multi: BooleanType;
2608
+ /** Whether the record's head state holds the index, built under the
2609
+ * declaration the deployed package carries. A deploy, a reindex and a
2610
+ * system commit build what the state lacks; a read through an index the
2611
+ * state holds no build of answers `index_not_found`. */
2612
+ readonly built: BooleanType;
2613
+ }>>;
2614
+ /** The migration chain the record declares, in order. A deployed record
2615
+ * has applied every step, since a deploy migrates it or is refused. */
2616
+ readonly migrations: ArrayType<StructType<{
2617
+ readonly name: StringType;
2618
+ /** The step's form — `value`, `rows` or `rekey` — which says what it
2619
+ * runs over: the whole state, its rows, or its rows under new keys. */
2620
+ readonly form: StringType;
2621
+ /** The record's type before the step. */
2622
+ readonly from: import("@elaraai/east").RecursiveType<VariantType<{
2623
+ readonly Never: NullType;
2624
+ readonly Null: NullType;
2625
+ readonly Boolean: NullType;
2626
+ readonly Integer: NullType;
2627
+ readonly Float: NullType;
2628
+ readonly String: NullType;
2629
+ readonly DateTime: NullType;
2630
+ readonly Blob: NullType;
2631
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2632
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2633
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2634
+ readonly Dict: StructType<{
2635
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2636
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2637
+ }>;
2638
+ readonly Struct: ArrayType<StructType<{
2639
+ readonly name: StringType;
2640
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2641
+ }>>;
2642
+ readonly Variant: ArrayType<StructType<{
2643
+ readonly name: StringType;
2644
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2645
+ }>>;
2646
+ readonly Recursive: VariantType<{
2647
+ readonly ref: IntegerType;
2648
+ readonly wrapper: StructType<{
2649
+ readonly id: IntegerType;
2650
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2651
+ }>;
2652
+ }>;
2653
+ readonly Function: StructType<{
2654
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2655
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2656
+ }>;
2657
+ readonly AsyncFunction: StructType<{
2658
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2659
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2660
+ }>;
2661
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2662
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2663
+ }>>;
2664
+ /** The record's type after it. */
2665
+ readonly to: import("@elaraai/east").RecursiveType<VariantType<{
2666
+ readonly Never: NullType;
2667
+ readonly Null: NullType;
2668
+ readonly Boolean: NullType;
2669
+ readonly Integer: NullType;
2670
+ readonly Float: NullType;
2671
+ readonly String: NullType;
2672
+ readonly DateTime: NullType;
2673
+ readonly Blob: NullType;
2674
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2675
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2676
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2677
+ readonly Dict: StructType<{
2678
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2679
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2680
+ }>;
2681
+ readonly Struct: ArrayType<StructType<{
2682
+ readonly name: StringType;
2683
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2684
+ }>>;
2685
+ readonly Variant: ArrayType<StructType<{
2686
+ readonly name: StringType;
2687
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2688
+ }>>;
2689
+ readonly Recursive: VariantType<{
2690
+ readonly ref: IntegerType;
2691
+ readonly wrapper: StructType<{
2692
+ readonly id: IntegerType;
2693
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2694
+ }>;
2695
+ }>;
2696
+ readonly Function: StructType<{
2697
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2698
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2699
+ }>;
2700
+ readonly AsyncFunction: StructType<{
2701
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2702
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2703
+ }>;
2704
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2705
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2706
+ }>>;
2707
+ /** When the record applied the step, and the commit that did; `none`
2708
+ * when it has not applied it. */
2709
+ readonly applied: OptionType<StructType<{
2710
+ readonly at: OptionType<DateTimeType>;
2711
+ readonly commit: OptionType<StringType>;
2712
+ }>>;
2462
2713
  }>>;
2463
2714
  }>;
2464
2715
  /** One commit in a record's history (its hash plus the commit fields). */
@@ -2473,6 +2724,195 @@ export declare const RecordCommitInfoType: StructType<{
2473
2724
  * changed without diffing two states. */
2474
2725
  readonly delta: OptionType<StringType>;
2475
2726
  }>;
2727
+ /**
2728
+ * One argument of a record's commit, as the history previews it.
2729
+ *
2730
+ * @property type - The argument's own East type, as its encoding carries it
2731
+ * @property bytes - Its encoded size
2732
+ * @property text - Its value printed as East text, cut at
2733
+ * {@link RECORD_ARG_TEXT_CHARS} characters; empty for an argument over
2734
+ * {@link RECORD_ARG_TEXT_BYTES}, which is not printed, and for one that
2735
+ * cannot be
2736
+ * @property truncated - Whether `text` holds less than the whole value
2737
+ */
2738
+ export declare const RecordArgPreviewType: StructType<{
2739
+ readonly type: import("@elaraai/east").RecursiveType<VariantType<{
2740
+ readonly Never: NullType;
2741
+ readonly Null: NullType;
2742
+ readonly Boolean: NullType;
2743
+ readonly Integer: NullType;
2744
+ readonly Float: NullType;
2745
+ readonly String: NullType;
2746
+ readonly DateTime: NullType;
2747
+ readonly Blob: NullType;
2748
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2749
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2750
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2751
+ readonly Dict: StructType<{
2752
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2753
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2754
+ }>;
2755
+ readonly Struct: ArrayType<StructType<{
2756
+ readonly name: StringType;
2757
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2758
+ }>>;
2759
+ readonly Variant: ArrayType<StructType<{
2760
+ readonly name: StringType;
2761
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2762
+ }>>;
2763
+ readonly Recursive: VariantType<{
2764
+ readonly ref: IntegerType;
2765
+ readonly wrapper: StructType<{
2766
+ readonly id: IntegerType;
2767
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2768
+ }>;
2769
+ }>;
2770
+ readonly Function: StructType<{
2771
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2772
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2773
+ }>;
2774
+ readonly AsyncFunction: StructType<{
2775
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2776
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2777
+ }>;
2778
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2779
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2780
+ }>>;
2781
+ readonly bytes: IntegerType;
2782
+ readonly text: StringType;
2783
+ readonly truncated: BooleanType;
2784
+ }>;
2785
+ /**
2786
+ * A record commit's arguments, as the history previews them.
2787
+ *
2788
+ * @property hash - The arguments' object, which the objects route serves
2789
+ * whole: a beast2 `Array<Blob>` of the encoded arguments, in order
2790
+ * @property bytes - The object's size
2791
+ * @property values - Each argument's preview, in order; empty when the object
2792
+ * is over {@link RECORD_ARGS_READ_BYTES}, which the history does not read,
2793
+ * or holds arguments that are not East values, as a system commit may
2794
+ * record its caller's
2795
+ */
2796
+ export declare const RecordCommitArgsType: StructType<{
2797
+ readonly hash: StringType;
2798
+ readonly bytes: IntegerType;
2799
+ readonly values: ArrayType<StructType<{
2800
+ readonly type: import("@elaraai/east").RecursiveType<VariantType<{
2801
+ readonly Never: NullType;
2802
+ readonly Null: NullType;
2803
+ readonly Boolean: NullType;
2804
+ readonly Integer: NullType;
2805
+ readonly Float: NullType;
2806
+ readonly String: NullType;
2807
+ readonly DateTime: NullType;
2808
+ readonly Blob: NullType;
2809
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2810
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2811
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2812
+ readonly Dict: StructType<{
2813
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2814
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2815
+ }>;
2816
+ readonly Struct: ArrayType<StructType<{
2817
+ readonly name: StringType;
2818
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2819
+ }>>;
2820
+ readonly Variant: ArrayType<StructType<{
2821
+ readonly name: StringType;
2822
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2823
+ }>>;
2824
+ readonly Recursive: VariantType<{
2825
+ readonly ref: IntegerType;
2826
+ readonly wrapper: StructType<{
2827
+ readonly id: IntegerType;
2828
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2829
+ }>;
2830
+ }>;
2831
+ readonly Function: StructType<{
2832
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2833
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2834
+ }>;
2835
+ readonly AsyncFunction: StructType<{
2836
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2837
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2838
+ }>;
2839
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2840
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2841
+ }>>;
2842
+ readonly bytes: IntegerType;
2843
+ readonly text: StringType;
2844
+ readonly truncated: BooleanType;
2845
+ }>>;
2846
+ }>;
2847
+ /**
2848
+ * One commit in a record's history, as the history route answers it: a
2849
+ * {@link RecordCommitInfoType}'s fields, and a preview of its arguments, so a
2850
+ * history says what a commit set as well as which mutation ran.
2851
+ * `RecordCommitInfoType` stays without them: e3-ui's record binding and the
2852
+ * pages built on it carry it in their East types.
2853
+ */
2854
+ export declare const RecordHistoryCommitType: StructType<{
2855
+ readonly hash: StringType;
2856
+ readonly parent: OptionType<StringType>;
2857
+ readonly state: StringType;
2858
+ readonly mutation: StringType;
2859
+ readonly actor: StringType;
2860
+ readonly at: DateTimeType;
2861
+ /** The delta this commit applied, when it wrote one. */
2862
+ readonly delta: OptionType<StringType>;
2863
+ /** The commit's arguments, previewed; `none` for a commit with none. */
2864
+ readonly args: OptionType<StructType<{
2865
+ readonly hash: StringType;
2866
+ readonly bytes: IntegerType;
2867
+ readonly values: ArrayType<StructType<{
2868
+ readonly type: import("@elaraai/east").RecursiveType<VariantType<{
2869
+ readonly Never: NullType;
2870
+ readonly Null: NullType;
2871
+ readonly Boolean: NullType;
2872
+ readonly Integer: NullType;
2873
+ readonly Float: NullType;
2874
+ readonly String: NullType;
2875
+ readonly DateTime: NullType;
2876
+ readonly Blob: NullType;
2877
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2878
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2879
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2880
+ readonly Dict: StructType<{
2881
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2882
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2883
+ }>;
2884
+ readonly Struct: ArrayType<StructType<{
2885
+ readonly name: StringType;
2886
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2887
+ }>>;
2888
+ readonly Variant: ArrayType<StructType<{
2889
+ readonly name: StringType;
2890
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2891
+ }>>;
2892
+ readonly Recursive: VariantType<{
2893
+ readonly ref: IntegerType;
2894
+ readonly wrapper: StructType<{
2895
+ readonly id: IntegerType;
2896
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2897
+ }>;
2898
+ }>;
2899
+ readonly Function: StructType<{
2900
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2901
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2902
+ }>;
2903
+ readonly AsyncFunction: StructType<{
2904
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2905
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2906
+ }>;
2907
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2908
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2909
+ }>>;
2910
+ readonly bytes: IntegerType;
2911
+ readonly text: StringType;
2912
+ readonly truncated: BooleanType;
2913
+ }>>;
2914
+ }>>;
2915
+ }>;
2476
2916
  /** A page of a record's commit history, newest first. */
2477
2917
  export declare const RecordHistoryResultType: StructType<{
2478
2918
  readonly commits: ArrayType<StructType<{
@@ -2482,11 +2922,71 @@ export declare const RecordHistoryResultType: StructType<{
2482
2922
  readonly mutation: StringType;
2483
2923
  readonly actor: StringType;
2484
2924
  readonly at: DateTimeType;
2485
- /** The delta this commit applied, when it wrote one — so history shows WHAT
2486
- * changed without diffing two states. */
2925
+ /** The delta this commit applied, when it wrote one. */
2487
2926
  readonly delta: OptionType<StringType>;
2927
+ /** The commit's arguments, previewed; `none` for a commit with none. */
2928
+ readonly args: OptionType<StructType<{
2929
+ readonly hash: StringType;
2930
+ readonly bytes: IntegerType;
2931
+ readonly values: ArrayType<StructType<{
2932
+ readonly type: import("@elaraai/east").RecursiveType<VariantType<{
2933
+ readonly Never: NullType;
2934
+ readonly Null: NullType;
2935
+ readonly Boolean: NullType;
2936
+ readonly Integer: NullType;
2937
+ readonly Float: NullType;
2938
+ readonly String: NullType;
2939
+ readonly DateTime: NullType;
2940
+ readonly Blob: NullType;
2941
+ readonly Ref: import("@elaraai/east").RecursiveTypeMarker;
2942
+ readonly Array: import("@elaraai/east").RecursiveTypeMarker;
2943
+ readonly Set: import("@elaraai/east").RecursiveTypeMarker;
2944
+ readonly Dict: StructType<{
2945
+ readonly key: import("@elaraai/east").RecursiveTypeMarker;
2946
+ readonly value: import("@elaraai/east").RecursiveTypeMarker;
2947
+ }>;
2948
+ readonly Struct: ArrayType<StructType<{
2949
+ readonly name: StringType;
2950
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2951
+ }>>;
2952
+ readonly Variant: ArrayType<StructType<{
2953
+ readonly name: StringType;
2954
+ readonly type: import("@elaraai/east").RecursiveTypeMarker;
2955
+ }>>;
2956
+ readonly Recursive: VariantType<{
2957
+ readonly ref: IntegerType;
2958
+ readonly wrapper: StructType<{
2959
+ readonly id: IntegerType;
2960
+ readonly inner: import("@elaraai/east").RecursiveTypeMarker;
2961
+ }>;
2962
+ }>;
2963
+ readonly Function: StructType<{
2964
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2965
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2966
+ }>;
2967
+ readonly AsyncFunction: StructType<{
2968
+ readonly inputs: ArrayType<import("@elaraai/east").RecursiveTypeMarker>;
2969
+ readonly output: import("@elaraai/east").RecursiveTypeMarker;
2970
+ }>;
2971
+ readonly Vector: import("@elaraai/east").RecursiveTypeMarker;
2972
+ readonly Matrix: import("@elaraai/east").RecursiveTypeMarker;
2973
+ }>>;
2974
+ readonly bytes: IntegerType;
2975
+ readonly text: StringType;
2976
+ readonly truncated: BooleanType;
2977
+ }>>;
2978
+ }>>;
2488
2979
  }>>;
2489
2980
  }>;
2981
+ /** The characters of an argument's East text a history preview keeps. */
2982
+ export declare const RECORD_ARG_TEXT_CHARS = 256;
2983
+ /** The encoded size, in bytes, past which a history preview prints no text
2984
+ * of an argument, only its type and size. */
2985
+ export declare const RECORD_ARG_TEXT_BYTES: number;
2986
+ /** The size, in bytes, past which a history reads no commit's arguments'
2987
+ * object, and previews none of them: a page reads at most this much of
2988
+ * arguments per commit, however large a patch is. */
2989
+ export declare const RECORD_ARGS_READ_BYTES: number;
2490
2990
  export type Error = ValueTypeOf<typeof ErrorType>;
2491
2991
  export type RepositoryStatus = ValueTypeOf<typeof RepositoryStatusType>;
2492
2992
  export type GcRequest = ValueTypeOf<typeof GcRequestType>;
@@ -2520,6 +3020,7 @@ export type TaskListItem = ValueTypeOf<typeof TaskListItemType>;
2520
3020
  export type TaskDetails = ValueTypeOf<typeof TaskDetailsType>;
2521
3021
  export type DataflowRequest = ValueTypeOf<typeof DataflowRequestType>;
2522
3022
  export type LogChunk = ValueTypeOf<typeof LogChunkType>;
3023
+ export type TaskLogChunk = ValueTypeOf<typeof TaskLogChunkType>;
2523
3024
  export type TaskExecutionResult = ValueTypeOf<typeof TaskExecutionResultType>;
2524
3025
  export type DataflowResult = ValueTypeOf<typeof DataflowResultType>;
2525
3026
  export type DataflowEvent = ValueTypeOf<typeof DataflowEventType>;
@@ -2537,6 +3038,7 @@ export type DatasetStatusDetail = ValueTypeOf<typeof DatasetStatusDetailType>;
2537
3038
  export type ExecuteLimits = ValueTypeOf<typeof ExecuteLimitsType>;
2538
3039
  export type Diagnostic = ValueTypeOf<typeof DiagnosticType>;
2539
3040
  export type ExecuteResult = ValueTypeOf<typeof ExecuteResultType>;
3041
+ export type CallArg = ValueTypeOf<typeof CallArgType>;
2540
3042
  export type FunctionCallRequest = ValueTypeOf<typeof FunctionCallRequestType>;
2541
3043
  export type FunctionSignature = ValueTypeOf<typeof FunctionSignatureType>;
2542
3044
  export type OneShotRequest = ValueTypeOf<typeof OneShotRequestType>;
@@ -2547,7 +3049,11 @@ export type SplitCallStatus = ValueTypeOf<typeof SplitCallStatusType>;
2547
3049
  export type SplitCallPlan = ValueTypeOf<typeof SplitCallPlanType>;
2548
3050
  export type MutationCallRequest = ValueTypeOf<typeof MutationCallRequestType>;
2549
3051
  export type MutationResult = ValueTypeOf<typeof MutationResultType>;
3052
+ export type RecordMigrationApplied = ValueTypeOf<typeof RecordMigrationAppliedType>;
2550
3053
  export type RecordSignature = ValueTypeOf<typeof RecordSignatureType>;
2551
3054
  export type RecordCommitInfo = ValueTypeOf<typeof RecordCommitInfoType>;
3055
+ export type RecordArgPreview = ValueTypeOf<typeof RecordArgPreviewType>;
3056
+ export type RecordCommitArgs = ValueTypeOf<typeof RecordCommitArgsType>;
3057
+ export type RecordHistoryCommit = ValueTypeOf<typeof RecordHistoryCommitType>;
2552
3058
  export type RecordHistoryResult = ValueTypeOf<typeof RecordHistoryResultType>;
2553
3059
  //# sourceMappingURL=api.d.ts.map