@uniformdev/assets 19.147.1-alpha.1 → 19.147.1-alpha.10
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/dist/index.d.mts +130 -0
- package/dist/index.d.ts +130 -0
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -515,6 +515,11 @@ interface external {
|
|
|
515
515
|
created?: string;
|
|
516
516
|
/** @description Last modified date string for this definition (ignored for writes) */
|
|
517
517
|
updated?: string;
|
|
518
|
+
/**
|
|
519
|
+
* Format: uuid
|
|
520
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached.
|
|
521
|
+
*/
|
|
522
|
+
workflowId?: string;
|
|
518
523
|
};
|
|
519
524
|
/** @description Defines a content type */
|
|
520
525
|
ContentType: {
|
|
@@ -562,6 +567,11 @@ interface external {
|
|
|
562
567
|
useTeamPermissions?: boolean;
|
|
563
568
|
/** @description Custom role permissions for this content type */
|
|
564
569
|
permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
570
|
+
/**
|
|
571
|
+
* Format: uuid
|
|
572
|
+
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached.
|
|
573
|
+
*/
|
|
574
|
+
workflowId?: string;
|
|
565
575
|
};
|
|
566
576
|
/** @description Defines an editable parameter on a component. */
|
|
567
577
|
ComponentParameter: {
|
|
@@ -698,6 +708,14 @@ interface external {
|
|
|
698
708
|
_slug?: string | null;
|
|
699
709
|
/** @description Friendly name of this component. */
|
|
700
710
|
_name: string;
|
|
711
|
+
/** @description Name of the author of the most recent change. */
|
|
712
|
+
_author?: string;
|
|
713
|
+
/** @description Identity subject of the author of the most recent change. */
|
|
714
|
+
_authorSubject?: string;
|
|
715
|
+
/** @description Name of the original creator. */
|
|
716
|
+
_creator?: string;
|
|
717
|
+
/** @description Identity subject of the original creator. */
|
|
718
|
+
_creatorSubject?: string;
|
|
701
719
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
702
720
|
_pattern?: string;
|
|
703
721
|
/**
|
|
@@ -917,6 +935,11 @@ interface external {
|
|
|
917
935
|
* If isPatternParameter is false or undefined, this has no meaning.
|
|
918
936
|
*/
|
|
919
937
|
ignorePatternParameterDefault?: boolean;
|
|
938
|
+
/**
|
|
939
|
+
* @description When true, the data resource does not create an error forcing the choosing an override value when there is no default.
|
|
940
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning.
|
|
941
|
+
*/
|
|
942
|
+
optionalPatternParameter?: boolean;
|
|
920
943
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
921
944
|
};
|
|
922
945
|
/** @description Variable values for a data resource. */
|
|
@@ -1024,6 +1047,113 @@ interface external {
|
|
|
1024
1047
|
/** @description Supported parameter types */
|
|
1025
1048
|
parameterTypes?: string[] | null;
|
|
1026
1049
|
};
|
|
1050
|
+
/** @description Definition of a workflow that can be assigned to entities */
|
|
1051
|
+
WorkflowDefinition: {
|
|
1052
|
+
/**
|
|
1053
|
+
* Format: uuid
|
|
1054
|
+
* @description Unique identifier of the workflow definition
|
|
1055
|
+
*/
|
|
1056
|
+
id: string;
|
|
1057
|
+
/** @description Workflow name */
|
|
1058
|
+
name: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Format: uuid
|
|
1061
|
+
* @description The ID of the initial stage in the stages object.
|
|
1062
|
+
*/
|
|
1063
|
+
initialStage: string;
|
|
1064
|
+
/** @description All stages of the workflow */
|
|
1065
|
+
stages: {
|
|
1066
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
|
|
1067
|
+
};
|
|
1068
|
+
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1069
|
+
modified?: string;
|
|
1070
|
+
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
1071
|
+
created?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* @description Name of the original creator of the workflow.
|
|
1074
|
+
* If undefined, the user has been removed from the team.
|
|
1075
|
+
* Ignored for writes.
|
|
1076
|
+
*/
|
|
1077
|
+
createdBy?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* @description Name of the last modifier of the workflow.
|
|
1080
|
+
* If undefined, the user has been removed from the team.
|
|
1081
|
+
* Ignored for writes.
|
|
1082
|
+
*/
|
|
1083
|
+
modifiedBy?: string;
|
|
1084
|
+
};
|
|
1085
|
+
/** @description Definition of a stage in a workflow */
|
|
1086
|
+
WorkflowStage: {
|
|
1087
|
+
/** @description Name of the stage */
|
|
1088
|
+
name: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
1091
|
+
* NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
1092
|
+
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
1093
|
+
* listed here, the stage is read only and publishing is disabled.
|
|
1094
|
+
*/
|
|
1095
|
+
permissions: {
|
|
1096
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
|
|
1097
|
+
};
|
|
1098
|
+
/**
|
|
1099
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
1100
|
+
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
1101
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
1102
|
+
* NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
|
|
1103
|
+
*/
|
|
1104
|
+
autoPublish?: boolean;
|
|
1105
|
+
/**
|
|
1106
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
1107
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
1108
|
+
* NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
|
|
1109
|
+
*/
|
|
1110
|
+
requireValidity?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* @description Defines transitions to other stages
|
|
1113
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1114
|
+
* has a stage that can never be escaped.
|
|
1115
|
+
*/
|
|
1116
|
+
transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
|
|
1117
|
+
/**
|
|
1118
|
+
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1119
|
+
* @default chevron-double-right-o
|
|
1120
|
+
*/
|
|
1121
|
+
icon?: string;
|
|
1122
|
+
/** @description Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
1123
|
+
order?: number;
|
|
1124
|
+
};
|
|
1125
|
+
/** @description Definition of a transition from one stage to another in a workflow */
|
|
1126
|
+
WorkflowStageTransition: {
|
|
1127
|
+
/**
|
|
1128
|
+
* Format: uuid
|
|
1129
|
+
* @description The target stage to transition to
|
|
1130
|
+
*/
|
|
1131
|
+
to: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* @description Name shown to the user when they execute this transition.
|
|
1134
|
+
* If not provided, a default name will be assigned automatically based on the target stage.
|
|
1135
|
+
*/
|
|
1136
|
+
name: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description Permissions for the stage transition.
|
|
1139
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
|
|
1140
|
+
*/
|
|
1141
|
+
permissions: {
|
|
1142
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
|
|
1143
|
+
};
|
|
1144
|
+
};
|
|
1145
|
+
/** @description Permissions for a workflow stage */
|
|
1146
|
+
WorkflowStagePermission: {
|
|
1147
|
+
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
|
|
1148
|
+
write?: boolean;
|
|
1149
|
+
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
|
|
1150
|
+
publish?: boolean;
|
|
1151
|
+
};
|
|
1152
|
+
/** @description Permissions for a workflow stage transition */
|
|
1153
|
+
WorkflowStageTransitionPermission: {
|
|
1154
|
+
/** @description Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it. */
|
|
1155
|
+
execute?: boolean;
|
|
1156
|
+
};
|
|
1027
1157
|
};
|
|
1028
1158
|
};
|
|
1029
1159
|
operations: {};
|
package/dist/index.d.ts
CHANGED
|
@@ -515,6 +515,11 @@ interface external {
|
|
|
515
515
|
created?: string;
|
|
516
516
|
/** @description Last modified date string for this definition (ignored for writes) */
|
|
517
517
|
updated?: string;
|
|
518
|
+
/**
|
|
519
|
+
* Format: uuid
|
|
520
|
+
* @description ID of the workflow that instances of this component definition will use by default. When not set, no workflow is attached.
|
|
521
|
+
*/
|
|
522
|
+
workflowId?: string;
|
|
518
523
|
};
|
|
519
524
|
/** @description Defines a content type */
|
|
520
525
|
ContentType: {
|
|
@@ -562,6 +567,11 @@ interface external {
|
|
|
562
567
|
useTeamPermissions?: boolean;
|
|
563
568
|
/** @description Custom role permissions for this content type */
|
|
564
569
|
permissions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
570
|
+
/**
|
|
571
|
+
* Format: uuid
|
|
572
|
+
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached.
|
|
573
|
+
*/
|
|
574
|
+
workflowId?: string;
|
|
565
575
|
};
|
|
566
576
|
/** @description Defines an editable parameter on a component. */
|
|
567
577
|
ComponentParameter: {
|
|
@@ -698,6 +708,14 @@ interface external {
|
|
|
698
708
|
_slug?: string | null;
|
|
699
709
|
/** @description Friendly name of this component. */
|
|
700
710
|
_name: string;
|
|
711
|
+
/** @description Name of the author of the most recent change. */
|
|
712
|
+
_author?: string;
|
|
713
|
+
/** @description Identity subject of the author of the most recent change. */
|
|
714
|
+
_authorSubject?: string;
|
|
715
|
+
/** @description Name of the original creator. */
|
|
716
|
+
_creator?: string;
|
|
717
|
+
/** @description Identity subject of the original creator. */
|
|
718
|
+
_creatorSubject?: string;
|
|
701
719
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
702
720
|
_pattern?: string;
|
|
703
721
|
/**
|
|
@@ -917,6 +935,11 @@ interface external {
|
|
|
917
935
|
* If isPatternParameter is false or undefined, this has no meaning.
|
|
918
936
|
*/
|
|
919
937
|
ignorePatternParameterDefault?: boolean;
|
|
938
|
+
/**
|
|
939
|
+
* @description When true, the data resource does not create an error forcing the choosing an override value when there is no default.
|
|
940
|
+
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning.
|
|
941
|
+
*/
|
|
942
|
+
optionalPatternParameter?: boolean;
|
|
920
943
|
variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
921
944
|
};
|
|
922
945
|
/** @description Variable values for a data resource. */
|
|
@@ -1024,6 +1047,113 @@ interface external {
|
|
|
1024
1047
|
/** @description Supported parameter types */
|
|
1025
1048
|
parameterTypes?: string[] | null;
|
|
1026
1049
|
};
|
|
1050
|
+
/** @description Definition of a workflow that can be assigned to entities */
|
|
1051
|
+
WorkflowDefinition: {
|
|
1052
|
+
/**
|
|
1053
|
+
* Format: uuid
|
|
1054
|
+
* @description Unique identifier of the workflow definition
|
|
1055
|
+
*/
|
|
1056
|
+
id: string;
|
|
1057
|
+
/** @description Workflow name */
|
|
1058
|
+
name: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Format: uuid
|
|
1061
|
+
* @description The ID of the initial stage in the stages object.
|
|
1062
|
+
*/
|
|
1063
|
+
initialStage: string;
|
|
1064
|
+
/** @description All stages of the workflow */
|
|
1065
|
+
stages: {
|
|
1066
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
|
|
1067
|
+
};
|
|
1068
|
+
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1069
|
+
modified?: string;
|
|
1070
|
+
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
1071
|
+
created?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* @description Name of the original creator of the workflow.
|
|
1074
|
+
* If undefined, the user has been removed from the team.
|
|
1075
|
+
* Ignored for writes.
|
|
1076
|
+
*/
|
|
1077
|
+
createdBy?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* @description Name of the last modifier of the workflow.
|
|
1080
|
+
* If undefined, the user has been removed from the team.
|
|
1081
|
+
* Ignored for writes.
|
|
1082
|
+
*/
|
|
1083
|
+
modifiedBy?: string;
|
|
1084
|
+
};
|
|
1085
|
+
/** @description Definition of a stage in a workflow */
|
|
1086
|
+
WorkflowStage: {
|
|
1087
|
+
/** @description Name of the stage */
|
|
1088
|
+
name: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
1091
|
+
* NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
1092
|
+
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
1093
|
+
* listed here, the stage is read only and publishing is disabled.
|
|
1094
|
+
*/
|
|
1095
|
+
permissions: {
|
|
1096
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
|
|
1097
|
+
};
|
|
1098
|
+
/**
|
|
1099
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
1100
|
+
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
1101
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
1102
|
+
* NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
|
|
1103
|
+
*/
|
|
1104
|
+
autoPublish?: boolean;
|
|
1105
|
+
/**
|
|
1106
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
1107
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
1108
|
+
* NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
|
|
1109
|
+
*/
|
|
1110
|
+
requireValidity?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* @description Defines transitions to other stages
|
|
1113
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1114
|
+
* has a stage that can never be escaped.
|
|
1115
|
+
*/
|
|
1116
|
+
transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
|
|
1117
|
+
/**
|
|
1118
|
+
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1119
|
+
* @default chevron-double-right-o
|
|
1120
|
+
*/
|
|
1121
|
+
icon?: string;
|
|
1122
|
+
/** @description Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
1123
|
+
order?: number;
|
|
1124
|
+
};
|
|
1125
|
+
/** @description Definition of a transition from one stage to another in a workflow */
|
|
1126
|
+
WorkflowStageTransition: {
|
|
1127
|
+
/**
|
|
1128
|
+
* Format: uuid
|
|
1129
|
+
* @description The target stage to transition to
|
|
1130
|
+
*/
|
|
1131
|
+
to: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* @description Name shown to the user when they execute this transition.
|
|
1134
|
+
* If not provided, a default name will be assigned automatically based on the target stage.
|
|
1135
|
+
*/
|
|
1136
|
+
name: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description Permissions for the stage transition.
|
|
1139
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
|
|
1140
|
+
*/
|
|
1141
|
+
permissions: {
|
|
1142
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
|
|
1143
|
+
};
|
|
1144
|
+
};
|
|
1145
|
+
/** @description Permissions for a workflow stage */
|
|
1146
|
+
WorkflowStagePermission: {
|
|
1147
|
+
/** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
|
|
1148
|
+
write?: boolean;
|
|
1149
|
+
/** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
|
|
1150
|
+
publish?: boolean;
|
|
1151
|
+
};
|
|
1152
|
+
/** @description Permissions for a workflow stage transition */
|
|
1153
|
+
WorkflowStageTransitionPermission: {
|
|
1154
|
+
/** @description Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it. */
|
|
1155
|
+
execute?: boolean;
|
|
1156
|
+
};
|
|
1027
1157
|
};
|
|
1028
1158
|
};
|
|
1029
1159
|
operations: {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/assets",
|
|
3
|
-
"version": "19.147.1-alpha.
|
|
3
|
+
"version": "19.147.1-alpha.10+6efbd31548",
|
|
4
4
|
"description": "Uniform Assets",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"access": "public"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@uniformdev/context": "19.147.1-alpha.
|
|
39
|
+
"@uniformdev/context": "19.147.1-alpha.10+6efbd31548"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "6efbd31548d4190f950f425f10ec9398de1aacb2"
|
|
42
42
|
}
|