@sanity/workflow-engine 0.28.0 → 0.29.0
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.
- package/CHANGELOG.md +150 -0
- package/DATAMODEL.md +107 -0
- package/dist/_chunks-cjs/invariants.cjs +179 -88
- package/dist/_chunks-es/invariants.js +174 -89
- package/dist/define.d.cts +187 -9
- package/dist/define.d.ts +187 -9
- package/dist/index.cjs +883 -468
- package/dist/index.d.cts +414 -19
- package/dist/index.d.ts +414 -19
- package/dist/index.js +880 -478
- package/package.json +1 -1
package/dist/define.d.cts
CHANGED
|
@@ -4,11 +4,6 @@ declare type Action = ActionFields<Op, string[]> & {
|
|
|
4
4
|
roles?: string[] | undefined;
|
|
5
5
|
};
|
|
6
6
|
|
|
7
|
-
declare const ACTION_SEMANTICS: readonly [
|
|
8
|
-
"decision.accept",
|
|
9
|
-
"decision.decline",
|
|
10
|
-
];
|
|
11
|
-
|
|
12
7
|
/** Type-mirror of {@link actionFields}, parameterised over the op and
|
|
13
8
|
* group-membership grammars. */
|
|
14
9
|
declare type ActionFields<TOp, TGroup> = {
|
|
@@ -160,7 +155,7 @@ declare const ActionParamSchema: v.SchemaWithPipe<
|
|
|
160
155
|
]
|
|
161
156
|
>;
|
|
162
157
|
|
|
163
|
-
declare type ActionSemantic =
|
|
158
|
+
declare type ActionSemantic = DecisionSemantic | Semantic;
|
|
164
159
|
|
|
165
160
|
declare type Activity = ActivityFields<
|
|
166
161
|
FieldEntry,
|
|
@@ -172,6 +167,7 @@ declare type Activity = ActivityFields<
|
|
|
172
167
|
/** Type-mirror of {@link activityFields}, parameterised over field/action/target/group. */
|
|
173
168
|
declare type ActivityFields<TField, TAction, TTarget, TGroup> = {
|
|
174
169
|
name: string;
|
|
170
|
+
semantics?: Semantic[] | undefined;
|
|
175
171
|
title?: string | undefined;
|
|
176
172
|
description?: string | undefined;
|
|
177
173
|
groups?: Group[] | undefined;
|
|
@@ -627,6 +623,31 @@ declare const AuthoringOpSchema: v.VariantSchema<
|
|
|
627
623
|
},
|
|
628
624
|
undefined
|
|
629
625
|
>,
|
|
626
|
+
v.StrictObjectSchema<
|
|
627
|
+
{
|
|
628
|
+
readonly type: v.LiteralSchema<"field.setIfMissing", undefined>;
|
|
629
|
+
readonly target: v.StrictObjectSchema<
|
|
630
|
+
{
|
|
631
|
+
readonly scope: v.OptionalSchema<
|
|
632
|
+
v.PicklistSchema<
|
|
633
|
+
readonly ["workflow", "stage", "activity"],
|
|
634
|
+
string
|
|
635
|
+
>,
|
|
636
|
+
undefined
|
|
637
|
+
>;
|
|
638
|
+
readonly field: v.SchemaWithPipe<
|
|
639
|
+
readonly [
|
|
640
|
+
v.StringSchema<undefined>,
|
|
641
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
642
|
+
]
|
|
643
|
+
>;
|
|
644
|
+
},
|
|
645
|
+
undefined
|
|
646
|
+
>;
|
|
647
|
+
readonly value: v.GenericSchema<ValueExprInternal>;
|
|
648
|
+
},
|
|
649
|
+
undefined
|
|
650
|
+
>,
|
|
630
651
|
v.StrictObjectSchema<
|
|
631
652
|
{
|
|
632
653
|
readonly type: v.LiteralSchema<"field.unset", undefined>;
|
|
@@ -676,6 +697,62 @@ declare const AuthoringOpSchema: v.VariantSchema<
|
|
|
676
697
|
},
|
|
677
698
|
undefined
|
|
678
699
|
>,
|
|
700
|
+
v.StrictObjectSchema<
|
|
701
|
+
{
|
|
702
|
+
readonly type: v.LiteralSchema<"field.inc", undefined>;
|
|
703
|
+
readonly target: v.StrictObjectSchema<
|
|
704
|
+
{
|
|
705
|
+
readonly scope: v.OptionalSchema<
|
|
706
|
+
v.PicklistSchema<
|
|
707
|
+
readonly ["workflow", "stage", "activity"],
|
|
708
|
+
string
|
|
709
|
+
>,
|
|
710
|
+
undefined
|
|
711
|
+
>;
|
|
712
|
+
readonly field: v.SchemaWithPipe<
|
|
713
|
+
readonly [
|
|
714
|
+
v.StringSchema<undefined>,
|
|
715
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
716
|
+
]
|
|
717
|
+
>;
|
|
718
|
+
},
|
|
719
|
+
undefined
|
|
720
|
+
>;
|
|
721
|
+
readonly value: v.OptionalSchema<
|
|
722
|
+
v.GenericSchema<ValueExprInternal>,
|
|
723
|
+
undefined
|
|
724
|
+
>;
|
|
725
|
+
},
|
|
726
|
+
undefined
|
|
727
|
+
>,
|
|
728
|
+
v.StrictObjectSchema<
|
|
729
|
+
{
|
|
730
|
+
readonly type: v.LiteralSchema<"field.dec", undefined>;
|
|
731
|
+
readonly target: v.StrictObjectSchema<
|
|
732
|
+
{
|
|
733
|
+
readonly scope: v.OptionalSchema<
|
|
734
|
+
v.PicklistSchema<
|
|
735
|
+
readonly ["workflow", "stage", "activity"],
|
|
736
|
+
string
|
|
737
|
+
>,
|
|
738
|
+
undefined
|
|
739
|
+
>;
|
|
740
|
+
readonly field: v.SchemaWithPipe<
|
|
741
|
+
readonly [
|
|
742
|
+
v.StringSchema<undefined>,
|
|
743
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
744
|
+
]
|
|
745
|
+
>;
|
|
746
|
+
},
|
|
747
|
+
undefined
|
|
748
|
+
>;
|
|
749
|
+
readonly value: v.OptionalSchema<
|
|
750
|
+
v.GenericSchema<ValueExprInternal>,
|
|
751
|
+
undefined
|
|
752
|
+
>;
|
|
753
|
+
},
|
|
754
|
+
undefined
|
|
755
|
+
>,
|
|
679
756
|
v.StrictObjectSchema<
|
|
680
757
|
{
|
|
681
758
|
readonly type: v.LiteralSchema<"field.updateWhere", undefined>;
|
|
@@ -983,6 +1060,9 @@ export declare interface ConditionVar {
|
|
|
983
1060
|
*/
|
|
984
1061
|
export declare type ConditionVarBinding = "always" | "caller" | "spawn";
|
|
985
1062
|
|
|
1063
|
+
/** A define-time validated `custom.<camelCaseMeaning>` value. */
|
|
1064
|
+
declare type CustomSemantic = `custom.${string}`;
|
|
1065
|
+
|
|
986
1066
|
/**
|
|
987
1067
|
* The maximum reader floor this writer can emit. Individual documents derive
|
|
988
1068
|
* their `minReaderModel` from the compatibility-bearing features actually
|
|
@@ -992,6 +1072,13 @@ export declare type ConditionVarBinding = "always" | "caller" | "spawn";
|
|
|
992
1072
|
*/
|
|
993
1073
|
declare const DATA_MODEL_MIN_READER = 4;
|
|
994
1074
|
|
|
1075
|
+
declare const DECISION_SEMANTICS: readonly [
|
|
1076
|
+
"decision.accept",
|
|
1077
|
+
"decision.decline",
|
|
1078
|
+
];
|
|
1079
|
+
|
|
1080
|
+
declare type DecisionSemantic = (typeof DECISION_SEMANTICS)[number];
|
|
1081
|
+
|
|
995
1082
|
export declare function defineAction(action: AuthoringAction): AuthoringAction;
|
|
996
1083
|
|
|
997
1084
|
export declare function defineActivity(
|
|
@@ -1518,6 +1605,16 @@ declare interface ScalarValidation {
|
|
|
1518
1605
|
max?: number | undefined;
|
|
1519
1606
|
}
|
|
1520
1607
|
|
|
1608
|
+
declare type Semantic = SignalSemantic | CustomSemantic;
|
|
1609
|
+
|
|
1610
|
+
declare const SIGNAL_SEMANTICS: readonly [
|
|
1611
|
+
"signal.positive",
|
|
1612
|
+
"signal.caution",
|
|
1613
|
+
"signal.critical",
|
|
1614
|
+
];
|
|
1615
|
+
|
|
1616
|
+
declare type SignalSemantic = (typeof SIGNAL_SEMANTICS)[number];
|
|
1617
|
+
|
|
1521
1618
|
declare type SingleSubjectRequirement = RequirementBase & {
|
|
1522
1619
|
type: "singleSubject";
|
|
1523
1620
|
};
|
|
@@ -1533,6 +1630,7 @@ declare type Stage = StageFields<
|
|
|
1533
1630
|
/** Type-mirror of {@link stageFields}, parameterised over field/activity/transition/guard/editable. */
|
|
1534
1631
|
declare type StageFields<TField, TActivity, TTransition, TGuard, TEditable> = {
|
|
1535
1632
|
name: string;
|
|
1633
|
+
semantics?: Semantic[] | undefined;
|
|
1536
1634
|
title?: string | undefined;
|
|
1537
1635
|
description?: string | undefined;
|
|
1538
1636
|
groups?: Group[] | undefined;
|
|
@@ -1575,9 +1673,9 @@ declare type StartRequirement = GroqRequirement | SingleSubjectRequirement;
|
|
|
1575
1673
|
* (absent) is NOT editable: a field is op-only engine working memory unless the
|
|
1576
1674
|
* modeler opens it. The stored form is `true` (editable by anyone within the
|
|
1577
1675
|
* field's scope window) or an EDIT CONDITION — rendered-scope GROQ (`$actor`,
|
|
1578
|
-
* `$can`, `$fields`, `$assigned`), checked like an action filter
|
|
1579
|
-
* who-may-edit. ADVISORY like every engine gate — it disables the
|
|
1580
|
-
* and explains; a {@link Guard} declares the intended write-lock.
|
|
1676
|
+
* `$can`, `$attributes`, `$fields`, `$assigned`), checked like an action filter
|
|
1677
|
+
* to decide who-may-edit. ADVISORY like every engine gate — it disables the
|
|
1678
|
+
* inline field and explains; a {@link Guard} declares the intended write-lock.
|
|
1581
1679
|
*/
|
|
1582
1680
|
declare const StoredEditableSchema: v.UnionSchema<
|
|
1583
1681
|
[
|
|
@@ -1658,6 +1756,28 @@ declare const StoredOpSchema: v.VariantSchema<
|
|
|
1658
1756
|
},
|
|
1659
1757
|
undefined
|
|
1660
1758
|
>,
|
|
1759
|
+
v.StrictObjectSchema<
|
|
1760
|
+
{
|
|
1761
|
+
readonly type: v.LiteralSchema<"field.setIfMissing", undefined>;
|
|
1762
|
+
readonly target: v.StrictObjectSchema<
|
|
1763
|
+
{
|
|
1764
|
+
readonly scope: v.PicklistSchema<
|
|
1765
|
+
readonly ["workflow", "stage", "activity"],
|
|
1766
|
+
string
|
|
1767
|
+
>;
|
|
1768
|
+
readonly field: v.SchemaWithPipe<
|
|
1769
|
+
readonly [
|
|
1770
|
+
v.StringSchema<undefined>,
|
|
1771
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1772
|
+
]
|
|
1773
|
+
>;
|
|
1774
|
+
},
|
|
1775
|
+
undefined
|
|
1776
|
+
>;
|
|
1777
|
+
readonly value: v.GenericSchema<ValueExprInternal>;
|
|
1778
|
+
},
|
|
1779
|
+
undefined
|
|
1780
|
+
>,
|
|
1661
1781
|
v.StrictObjectSchema<
|
|
1662
1782
|
{
|
|
1663
1783
|
readonly type: v.LiteralSchema<"field.unset", undefined>;
|
|
@@ -1701,6 +1821,56 @@ declare const StoredOpSchema: v.VariantSchema<
|
|
|
1701
1821
|
},
|
|
1702
1822
|
undefined
|
|
1703
1823
|
>,
|
|
1824
|
+
v.StrictObjectSchema<
|
|
1825
|
+
{
|
|
1826
|
+
readonly type: v.LiteralSchema<"field.inc", undefined>;
|
|
1827
|
+
readonly target: v.StrictObjectSchema<
|
|
1828
|
+
{
|
|
1829
|
+
readonly scope: v.PicklistSchema<
|
|
1830
|
+
readonly ["workflow", "stage", "activity"],
|
|
1831
|
+
string
|
|
1832
|
+
>;
|
|
1833
|
+
readonly field: v.SchemaWithPipe<
|
|
1834
|
+
readonly [
|
|
1835
|
+
v.StringSchema<undefined>,
|
|
1836
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1837
|
+
]
|
|
1838
|
+
>;
|
|
1839
|
+
},
|
|
1840
|
+
undefined
|
|
1841
|
+
>;
|
|
1842
|
+
readonly value: v.OptionalSchema<
|
|
1843
|
+
v.GenericSchema<ValueExprInternal>,
|
|
1844
|
+
undefined
|
|
1845
|
+
>;
|
|
1846
|
+
},
|
|
1847
|
+
undefined
|
|
1848
|
+
>,
|
|
1849
|
+
v.StrictObjectSchema<
|
|
1850
|
+
{
|
|
1851
|
+
readonly type: v.LiteralSchema<"field.dec", undefined>;
|
|
1852
|
+
readonly target: v.StrictObjectSchema<
|
|
1853
|
+
{
|
|
1854
|
+
readonly scope: v.PicklistSchema<
|
|
1855
|
+
readonly ["workflow", "stage", "activity"],
|
|
1856
|
+
string
|
|
1857
|
+
>;
|
|
1858
|
+
readonly field: v.SchemaWithPipe<
|
|
1859
|
+
readonly [
|
|
1860
|
+
v.StringSchema<undefined>,
|
|
1861
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1862
|
+
]
|
|
1863
|
+
>;
|
|
1864
|
+
},
|
|
1865
|
+
undefined
|
|
1866
|
+
>;
|
|
1867
|
+
readonly value: v.OptionalSchema<
|
|
1868
|
+
v.GenericSchema<ValueExprInternal>,
|
|
1869
|
+
undefined
|
|
1870
|
+
>;
|
|
1871
|
+
},
|
|
1872
|
+
undefined
|
|
1873
|
+
>,
|
|
1704
1874
|
v.StrictObjectSchema<
|
|
1705
1875
|
{
|
|
1706
1876
|
readonly type: v.LiteralSchema<"field.updateWhere", undefined>;
|
|
@@ -2216,6 +2386,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2216
2386
|
v.CustomSchema<
|
|
2217
2387
|
{
|
|
2218
2388
|
name: string;
|
|
2389
|
+
semantics?: Semantic[] | undefined;
|
|
2219
2390
|
title: string;
|
|
2220
2391
|
description?: string | undefined;
|
|
2221
2392
|
groups?: Group[] | undefined;
|
|
@@ -2234,6 +2405,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2234
2405
|
v.MinLengthAction<
|
|
2235
2406
|
{
|
|
2236
2407
|
name: string;
|
|
2408
|
+
semantics?: Semantic[] | undefined;
|
|
2237
2409
|
title: string;
|
|
2238
2410
|
description?: string | undefined;
|
|
2239
2411
|
groups?: Group[] | undefined;
|
|
@@ -2301,6 +2473,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2301
2473
|
| undefined;
|
|
2302
2474
|
definitions: {
|
|
2303
2475
|
name: string;
|
|
2476
|
+
semantics?: Semantic[] | undefined;
|
|
2304
2477
|
title: string;
|
|
2305
2478
|
description?: string | undefined;
|
|
2306
2479
|
groups?: Group[] | undefined;
|
|
@@ -2362,6 +2535,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2362
2535
|
| undefined;
|
|
2363
2536
|
definitions: {
|
|
2364
2537
|
name: string;
|
|
2538
|
+
semantics?: Semantic[] | undefined;
|
|
2365
2539
|
title: string;
|
|
2366
2540
|
description?: string | undefined;
|
|
2367
2541
|
groups?: Group[] | undefined;
|
|
@@ -2421,6 +2595,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2421
2595
|
| undefined;
|
|
2422
2596
|
definitions: {
|
|
2423
2597
|
name: string;
|
|
2598
|
+
semantics?: Semantic[] | undefined;
|
|
2424
2599
|
title: string;
|
|
2425
2600
|
description?: string | undefined;
|
|
2426
2601
|
groups?: Group[] | undefined;
|
|
@@ -2482,6 +2657,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2482
2657
|
| undefined;
|
|
2483
2658
|
definitions: {
|
|
2484
2659
|
name: string;
|
|
2660
|
+
semantics?: Semantic[] | undefined;
|
|
2485
2661
|
title: string;
|
|
2486
2662
|
description?: string | undefined;
|
|
2487
2663
|
groups?: Group[] | undefined;
|
|
@@ -2541,6 +2717,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2541
2717
|
| undefined;
|
|
2542
2718
|
definitions: {
|
|
2543
2719
|
name: string;
|
|
2720
|
+
semantics?: Semantic[] | undefined;
|
|
2544
2721
|
title: string;
|
|
2545
2722
|
description?: string | undefined;
|
|
2546
2723
|
groups?: Group[] | undefined;
|
|
@@ -2628,6 +2805,7 @@ declare type WorkflowFields<TField, TStage, TStart> = {
|
|
|
2628
2805
|
* subworkflows resolve by it.
|
|
2629
2806
|
*/
|
|
2630
2807
|
name: string;
|
|
2808
|
+
semantics?: Semantic[] | undefined;
|
|
2631
2809
|
title: string;
|
|
2632
2810
|
description?: string | undefined;
|
|
2633
2811
|
groups?: Group[] | undefined;
|
package/dist/define.d.ts
CHANGED
|
@@ -4,11 +4,6 @@ declare type Action = ActionFields<Op, string[]> & {
|
|
|
4
4
|
roles?: string[] | undefined;
|
|
5
5
|
};
|
|
6
6
|
|
|
7
|
-
declare const ACTION_SEMANTICS: readonly [
|
|
8
|
-
"decision.accept",
|
|
9
|
-
"decision.decline",
|
|
10
|
-
];
|
|
11
|
-
|
|
12
7
|
/** Type-mirror of {@link actionFields}, parameterised over the op and
|
|
13
8
|
* group-membership grammars. */
|
|
14
9
|
declare type ActionFields<TOp, TGroup> = {
|
|
@@ -160,7 +155,7 @@ declare const ActionParamSchema: v.SchemaWithPipe<
|
|
|
160
155
|
]
|
|
161
156
|
>;
|
|
162
157
|
|
|
163
|
-
declare type ActionSemantic =
|
|
158
|
+
declare type ActionSemantic = DecisionSemantic | Semantic;
|
|
164
159
|
|
|
165
160
|
declare type Activity = ActivityFields<
|
|
166
161
|
FieldEntry,
|
|
@@ -172,6 +167,7 @@ declare type Activity = ActivityFields<
|
|
|
172
167
|
/** Type-mirror of {@link activityFields}, parameterised over field/action/target/group. */
|
|
173
168
|
declare type ActivityFields<TField, TAction, TTarget, TGroup> = {
|
|
174
169
|
name: string;
|
|
170
|
+
semantics?: Semantic[] | undefined;
|
|
175
171
|
title?: string | undefined;
|
|
176
172
|
description?: string | undefined;
|
|
177
173
|
groups?: Group[] | undefined;
|
|
@@ -627,6 +623,31 @@ declare const AuthoringOpSchema: v.VariantSchema<
|
|
|
627
623
|
},
|
|
628
624
|
undefined
|
|
629
625
|
>,
|
|
626
|
+
v.StrictObjectSchema<
|
|
627
|
+
{
|
|
628
|
+
readonly type: v.LiteralSchema<"field.setIfMissing", undefined>;
|
|
629
|
+
readonly target: v.StrictObjectSchema<
|
|
630
|
+
{
|
|
631
|
+
readonly scope: v.OptionalSchema<
|
|
632
|
+
v.PicklistSchema<
|
|
633
|
+
readonly ["workflow", "stage", "activity"],
|
|
634
|
+
string
|
|
635
|
+
>,
|
|
636
|
+
undefined
|
|
637
|
+
>;
|
|
638
|
+
readonly field: v.SchemaWithPipe<
|
|
639
|
+
readonly [
|
|
640
|
+
v.StringSchema<undefined>,
|
|
641
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
642
|
+
]
|
|
643
|
+
>;
|
|
644
|
+
},
|
|
645
|
+
undefined
|
|
646
|
+
>;
|
|
647
|
+
readonly value: v.GenericSchema<ValueExprInternal>;
|
|
648
|
+
},
|
|
649
|
+
undefined
|
|
650
|
+
>,
|
|
630
651
|
v.StrictObjectSchema<
|
|
631
652
|
{
|
|
632
653
|
readonly type: v.LiteralSchema<"field.unset", undefined>;
|
|
@@ -676,6 +697,62 @@ declare const AuthoringOpSchema: v.VariantSchema<
|
|
|
676
697
|
},
|
|
677
698
|
undefined
|
|
678
699
|
>,
|
|
700
|
+
v.StrictObjectSchema<
|
|
701
|
+
{
|
|
702
|
+
readonly type: v.LiteralSchema<"field.inc", undefined>;
|
|
703
|
+
readonly target: v.StrictObjectSchema<
|
|
704
|
+
{
|
|
705
|
+
readonly scope: v.OptionalSchema<
|
|
706
|
+
v.PicklistSchema<
|
|
707
|
+
readonly ["workflow", "stage", "activity"],
|
|
708
|
+
string
|
|
709
|
+
>,
|
|
710
|
+
undefined
|
|
711
|
+
>;
|
|
712
|
+
readonly field: v.SchemaWithPipe<
|
|
713
|
+
readonly [
|
|
714
|
+
v.StringSchema<undefined>,
|
|
715
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
716
|
+
]
|
|
717
|
+
>;
|
|
718
|
+
},
|
|
719
|
+
undefined
|
|
720
|
+
>;
|
|
721
|
+
readonly value: v.OptionalSchema<
|
|
722
|
+
v.GenericSchema<ValueExprInternal>,
|
|
723
|
+
undefined
|
|
724
|
+
>;
|
|
725
|
+
},
|
|
726
|
+
undefined
|
|
727
|
+
>,
|
|
728
|
+
v.StrictObjectSchema<
|
|
729
|
+
{
|
|
730
|
+
readonly type: v.LiteralSchema<"field.dec", undefined>;
|
|
731
|
+
readonly target: v.StrictObjectSchema<
|
|
732
|
+
{
|
|
733
|
+
readonly scope: v.OptionalSchema<
|
|
734
|
+
v.PicklistSchema<
|
|
735
|
+
readonly ["workflow", "stage", "activity"],
|
|
736
|
+
string
|
|
737
|
+
>,
|
|
738
|
+
undefined
|
|
739
|
+
>;
|
|
740
|
+
readonly field: v.SchemaWithPipe<
|
|
741
|
+
readonly [
|
|
742
|
+
v.StringSchema<undefined>,
|
|
743
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
744
|
+
]
|
|
745
|
+
>;
|
|
746
|
+
},
|
|
747
|
+
undefined
|
|
748
|
+
>;
|
|
749
|
+
readonly value: v.OptionalSchema<
|
|
750
|
+
v.GenericSchema<ValueExprInternal>,
|
|
751
|
+
undefined
|
|
752
|
+
>;
|
|
753
|
+
},
|
|
754
|
+
undefined
|
|
755
|
+
>,
|
|
679
756
|
v.StrictObjectSchema<
|
|
680
757
|
{
|
|
681
758
|
readonly type: v.LiteralSchema<"field.updateWhere", undefined>;
|
|
@@ -983,6 +1060,9 @@ export declare interface ConditionVar {
|
|
|
983
1060
|
*/
|
|
984
1061
|
export declare type ConditionVarBinding = "always" | "caller" | "spawn";
|
|
985
1062
|
|
|
1063
|
+
/** A define-time validated `custom.<camelCaseMeaning>` value. */
|
|
1064
|
+
declare type CustomSemantic = `custom.${string}`;
|
|
1065
|
+
|
|
986
1066
|
/**
|
|
987
1067
|
* The maximum reader floor this writer can emit. Individual documents derive
|
|
988
1068
|
* their `minReaderModel` from the compatibility-bearing features actually
|
|
@@ -992,6 +1072,13 @@ export declare type ConditionVarBinding = "always" | "caller" | "spawn";
|
|
|
992
1072
|
*/
|
|
993
1073
|
declare const DATA_MODEL_MIN_READER = 4;
|
|
994
1074
|
|
|
1075
|
+
declare const DECISION_SEMANTICS: readonly [
|
|
1076
|
+
"decision.accept",
|
|
1077
|
+
"decision.decline",
|
|
1078
|
+
];
|
|
1079
|
+
|
|
1080
|
+
declare type DecisionSemantic = (typeof DECISION_SEMANTICS)[number];
|
|
1081
|
+
|
|
995
1082
|
export declare function defineAction(action: AuthoringAction): AuthoringAction;
|
|
996
1083
|
|
|
997
1084
|
export declare function defineActivity(
|
|
@@ -1518,6 +1605,16 @@ declare interface ScalarValidation {
|
|
|
1518
1605
|
max?: number | undefined;
|
|
1519
1606
|
}
|
|
1520
1607
|
|
|
1608
|
+
declare type Semantic = SignalSemantic | CustomSemantic;
|
|
1609
|
+
|
|
1610
|
+
declare const SIGNAL_SEMANTICS: readonly [
|
|
1611
|
+
"signal.positive",
|
|
1612
|
+
"signal.caution",
|
|
1613
|
+
"signal.critical",
|
|
1614
|
+
];
|
|
1615
|
+
|
|
1616
|
+
declare type SignalSemantic = (typeof SIGNAL_SEMANTICS)[number];
|
|
1617
|
+
|
|
1521
1618
|
declare type SingleSubjectRequirement = RequirementBase & {
|
|
1522
1619
|
type: "singleSubject";
|
|
1523
1620
|
};
|
|
@@ -1533,6 +1630,7 @@ declare type Stage = StageFields<
|
|
|
1533
1630
|
/** Type-mirror of {@link stageFields}, parameterised over field/activity/transition/guard/editable. */
|
|
1534
1631
|
declare type StageFields<TField, TActivity, TTransition, TGuard, TEditable> = {
|
|
1535
1632
|
name: string;
|
|
1633
|
+
semantics?: Semantic[] | undefined;
|
|
1536
1634
|
title?: string | undefined;
|
|
1537
1635
|
description?: string | undefined;
|
|
1538
1636
|
groups?: Group[] | undefined;
|
|
@@ -1575,9 +1673,9 @@ declare type StartRequirement = GroqRequirement | SingleSubjectRequirement;
|
|
|
1575
1673
|
* (absent) is NOT editable: a field is op-only engine working memory unless the
|
|
1576
1674
|
* modeler opens it. The stored form is `true` (editable by anyone within the
|
|
1577
1675
|
* field's scope window) or an EDIT CONDITION — rendered-scope GROQ (`$actor`,
|
|
1578
|
-
* `$can`, `$fields`, `$assigned`), checked like an action filter
|
|
1579
|
-
* who-may-edit. ADVISORY like every engine gate — it disables the
|
|
1580
|
-
* and explains; a {@link Guard} declares the intended write-lock.
|
|
1676
|
+
* `$can`, `$attributes`, `$fields`, `$assigned`), checked like an action filter
|
|
1677
|
+
* to decide who-may-edit. ADVISORY like every engine gate — it disables the
|
|
1678
|
+
* inline field and explains; a {@link Guard} declares the intended write-lock.
|
|
1581
1679
|
*/
|
|
1582
1680
|
declare const StoredEditableSchema: v.UnionSchema<
|
|
1583
1681
|
[
|
|
@@ -1658,6 +1756,28 @@ declare const StoredOpSchema: v.VariantSchema<
|
|
|
1658
1756
|
},
|
|
1659
1757
|
undefined
|
|
1660
1758
|
>,
|
|
1759
|
+
v.StrictObjectSchema<
|
|
1760
|
+
{
|
|
1761
|
+
readonly type: v.LiteralSchema<"field.setIfMissing", undefined>;
|
|
1762
|
+
readonly target: v.StrictObjectSchema<
|
|
1763
|
+
{
|
|
1764
|
+
readonly scope: v.PicklistSchema<
|
|
1765
|
+
readonly ["workflow", "stage", "activity"],
|
|
1766
|
+
string
|
|
1767
|
+
>;
|
|
1768
|
+
readonly field: v.SchemaWithPipe<
|
|
1769
|
+
readonly [
|
|
1770
|
+
v.StringSchema<undefined>,
|
|
1771
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1772
|
+
]
|
|
1773
|
+
>;
|
|
1774
|
+
},
|
|
1775
|
+
undefined
|
|
1776
|
+
>;
|
|
1777
|
+
readonly value: v.GenericSchema<ValueExprInternal>;
|
|
1778
|
+
},
|
|
1779
|
+
undefined
|
|
1780
|
+
>,
|
|
1661
1781
|
v.StrictObjectSchema<
|
|
1662
1782
|
{
|
|
1663
1783
|
readonly type: v.LiteralSchema<"field.unset", undefined>;
|
|
@@ -1701,6 +1821,56 @@ declare const StoredOpSchema: v.VariantSchema<
|
|
|
1701
1821
|
},
|
|
1702
1822
|
undefined
|
|
1703
1823
|
>,
|
|
1824
|
+
v.StrictObjectSchema<
|
|
1825
|
+
{
|
|
1826
|
+
readonly type: v.LiteralSchema<"field.inc", undefined>;
|
|
1827
|
+
readonly target: v.StrictObjectSchema<
|
|
1828
|
+
{
|
|
1829
|
+
readonly scope: v.PicklistSchema<
|
|
1830
|
+
readonly ["workflow", "stage", "activity"],
|
|
1831
|
+
string
|
|
1832
|
+
>;
|
|
1833
|
+
readonly field: v.SchemaWithPipe<
|
|
1834
|
+
readonly [
|
|
1835
|
+
v.StringSchema<undefined>,
|
|
1836
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1837
|
+
]
|
|
1838
|
+
>;
|
|
1839
|
+
},
|
|
1840
|
+
undefined
|
|
1841
|
+
>;
|
|
1842
|
+
readonly value: v.OptionalSchema<
|
|
1843
|
+
v.GenericSchema<ValueExprInternal>,
|
|
1844
|
+
undefined
|
|
1845
|
+
>;
|
|
1846
|
+
},
|
|
1847
|
+
undefined
|
|
1848
|
+
>,
|
|
1849
|
+
v.StrictObjectSchema<
|
|
1850
|
+
{
|
|
1851
|
+
readonly type: v.LiteralSchema<"field.dec", undefined>;
|
|
1852
|
+
readonly target: v.StrictObjectSchema<
|
|
1853
|
+
{
|
|
1854
|
+
readonly scope: v.PicklistSchema<
|
|
1855
|
+
readonly ["workflow", "stage", "activity"],
|
|
1856
|
+
string
|
|
1857
|
+
>;
|
|
1858
|
+
readonly field: v.SchemaWithPipe<
|
|
1859
|
+
readonly [
|
|
1860
|
+
v.StringSchema<undefined>,
|
|
1861
|
+
v.MinLengthAction<string, 1, "must be a non-empty string">,
|
|
1862
|
+
]
|
|
1863
|
+
>;
|
|
1864
|
+
},
|
|
1865
|
+
undefined
|
|
1866
|
+
>;
|
|
1867
|
+
readonly value: v.OptionalSchema<
|
|
1868
|
+
v.GenericSchema<ValueExprInternal>,
|
|
1869
|
+
undefined
|
|
1870
|
+
>;
|
|
1871
|
+
},
|
|
1872
|
+
undefined
|
|
1873
|
+
>,
|
|
1704
1874
|
v.StrictObjectSchema<
|
|
1705
1875
|
{
|
|
1706
1876
|
readonly type: v.LiteralSchema<"field.updateWhere", undefined>;
|
|
@@ -2216,6 +2386,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2216
2386
|
v.CustomSchema<
|
|
2217
2387
|
{
|
|
2218
2388
|
name: string;
|
|
2389
|
+
semantics?: Semantic[] | undefined;
|
|
2219
2390
|
title: string;
|
|
2220
2391
|
description?: string | undefined;
|
|
2221
2392
|
groups?: Group[] | undefined;
|
|
@@ -2234,6 +2405,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2234
2405
|
v.MinLengthAction<
|
|
2235
2406
|
{
|
|
2236
2407
|
name: string;
|
|
2408
|
+
semantics?: Semantic[] | undefined;
|
|
2237
2409
|
title: string;
|
|
2238
2410
|
description?: string | undefined;
|
|
2239
2411
|
groups?: Group[] | undefined;
|
|
@@ -2301,6 +2473,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2301
2473
|
| undefined;
|
|
2302
2474
|
definitions: {
|
|
2303
2475
|
name: string;
|
|
2476
|
+
semantics?: Semantic[] | undefined;
|
|
2304
2477
|
title: string;
|
|
2305
2478
|
description?: string | undefined;
|
|
2306
2479
|
groups?: Group[] | undefined;
|
|
@@ -2362,6 +2535,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2362
2535
|
| undefined;
|
|
2363
2536
|
definitions: {
|
|
2364
2537
|
name: string;
|
|
2538
|
+
semantics?: Semantic[] | undefined;
|
|
2365
2539
|
title: string;
|
|
2366
2540
|
description?: string | undefined;
|
|
2367
2541
|
groups?: Group[] | undefined;
|
|
@@ -2421,6 +2595,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2421
2595
|
| undefined;
|
|
2422
2596
|
definitions: {
|
|
2423
2597
|
name: string;
|
|
2598
|
+
semantics?: Semantic[] | undefined;
|
|
2424
2599
|
title: string;
|
|
2425
2600
|
description?: string | undefined;
|
|
2426
2601
|
groups?: Group[] | undefined;
|
|
@@ -2482,6 +2657,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2482
2657
|
| undefined;
|
|
2483
2658
|
definitions: {
|
|
2484
2659
|
name: string;
|
|
2660
|
+
semantics?: Semantic[] | undefined;
|
|
2485
2661
|
title: string;
|
|
2486
2662
|
description?: string | undefined;
|
|
2487
2663
|
groups?: Group[] | undefined;
|
|
@@ -2541,6 +2717,7 @@ declare const WorkflowConfigSchema: v.ObjectSchema<
|
|
|
2541
2717
|
| undefined;
|
|
2542
2718
|
definitions: {
|
|
2543
2719
|
name: string;
|
|
2720
|
+
semantics?: Semantic[] | undefined;
|
|
2544
2721
|
title: string;
|
|
2545
2722
|
description?: string | undefined;
|
|
2546
2723
|
groups?: Group[] | undefined;
|
|
@@ -2628,6 +2805,7 @@ declare type WorkflowFields<TField, TStage, TStart> = {
|
|
|
2628
2805
|
* subworkflows resolve by it.
|
|
2629
2806
|
*/
|
|
2630
2807
|
name: string;
|
|
2808
|
+
semantics?: Semantic[] | undefined;
|
|
2631
2809
|
title: string;
|
|
2632
2810
|
description?: string | undefined;
|
|
2633
2811
|
groups?: Group[] | undefined;
|