@uniformdev/assets 19.134.3-alpha.28 → 19.135.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 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: {
@@ -588,6 +598,35 @@ interface external {
588
598
  * @enum {string}
589
599
  */
590
600
  syntax: "jptr";
601
+ /**
602
+ * @description The action to take if the dynamic token cannot be resolved
603
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
604
+ * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
605
+ * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
606
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
607
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
608
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
609
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
610
+ * it is treated as an 'a' failure because removing the root means we must remove all.
611
+ * - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses.
612
+ *
613
+ * @enum {string}
614
+ */
615
+ failureAction?: "t" | "p" | "c" | "a";
616
+ /**
617
+ * @description How to report when the dynamic token cannot be resolved
618
+ * - e: ERROR: Report an error message (this will prevent publishing)
619
+ * - w: WARNING: Report a warning message [default]
620
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
621
+ *
622
+ * @enum {string}
623
+ */
624
+ failureLogLevel?: "e" | "w" | "i";
625
+ /**
626
+ * @description The default value to use if the dynamic token cannot be resolved.
627
+ * This is only used if the failureAction is the default (undefined, or explicitly token).
628
+ */
629
+ failureDefault?: string;
591
630
  };
592
631
  /** @description Defines the shape of a component instance served by the composition API. */
593
632
  ComponentInstance: {
@@ -669,6 +708,14 @@ interface external {
669
708
  _slug?: string | null;
670
709
  /** @description Friendly name of this component. */
671
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;
672
719
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
673
720
  _pattern?: string;
674
721
  /**
@@ -762,7 +809,7 @@ interface external {
762
809
  id: string;
763
810
  /** @description Display name of the data source */
764
811
  displayName: string;
765
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
812
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
766
813
  connectorType: string;
767
814
  /** @description Base resource URL of the data source. No trailing slash. */
768
815
  baseUrl: string;
@@ -995,6 +1042,113 @@ interface external {
995
1042
  /** @description Supported parameter types */
996
1043
  parameterTypes?: string[] | null;
997
1044
  };
1045
+ /** @description Definition of a workflow that can be assigned to entities */
1046
+ WorkflowDefinition: {
1047
+ /**
1048
+ * Format: uuid
1049
+ * @description Unique identifier of the workflow definition
1050
+ */
1051
+ id: string;
1052
+ /** @description Workflow name */
1053
+ name: string;
1054
+ /**
1055
+ * Format: uuid
1056
+ * @description The ID of the initial stage in the stages object.
1057
+ */
1058
+ initialStage: string;
1059
+ /** @description All stages of the workflow */
1060
+ stages: {
1061
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
1062
+ };
1063
+ /** @description Last modified ISO date string for this definition (ignored for writes) */
1064
+ modified?: string;
1065
+ /** @description Created ISO date string for this definition (ignored for writes) */
1066
+ created?: string;
1067
+ /**
1068
+ * @description Name of the original creator of the workflow.
1069
+ * If undefined, the user has been removed from the team.
1070
+ * Ignored for writes.
1071
+ */
1072
+ createdBy?: string;
1073
+ /**
1074
+ * @description Name of the last modifier of the workflow.
1075
+ * If undefined, the user has been removed from the team.
1076
+ * Ignored for writes.
1077
+ */
1078
+ modifiedBy?: string;
1079
+ };
1080
+ /** @description Definition of a stage in a workflow */
1081
+ WorkflowStage: {
1082
+ /** @description Name of the stage */
1083
+ name: string;
1084
+ /**
1085
+ * @description Defines roles which have permissions to this workflow stage
1086
+ * NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1087
+ * 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
1088
+ * listed here, the stage is read only and publishing is disabled.
1089
+ */
1090
+ permissions: {
1091
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
1092
+ };
1093
+ /**
1094
+ * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
1095
+ * 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.
1096
+ * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
1097
+ * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1098
+ */
1099
+ autoPublish?: boolean;
1100
+ /**
1101
+ * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
1102
+ * If the entity is not valid, the transition will not be allowed.
1103
+ * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1104
+ */
1105
+ requireValidity?: boolean;
1106
+ /**
1107
+ * @description Defines transitions to other stages
1108
+ * Every stage must define at least one transition, to avoid creating a workflow that
1109
+ * has a stage that can never be escaped.
1110
+ */
1111
+ transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
1112
+ /**
1113
+ * @description Icon name for the stage (e.g. 'chevron-double-right-o')
1114
+ * @default chevron-double-right-o
1115
+ */
1116
+ icon?: string;
1117
+ /** @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. */
1118
+ order?: number;
1119
+ };
1120
+ /** @description Definition of a transition from one stage to another in a workflow */
1121
+ WorkflowStageTransition: {
1122
+ /**
1123
+ * Format: uuid
1124
+ * @description The target stage to transition to
1125
+ */
1126
+ to: string;
1127
+ /**
1128
+ * @description Name shown to the user when they execute this transition.
1129
+ * If not provided, a default name will be assigned automatically based on the target stage.
1130
+ */
1131
+ name: string;
1132
+ /**
1133
+ * @description Permissions for the stage transition.
1134
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
1135
+ */
1136
+ permissions: {
1137
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
1138
+ };
1139
+ };
1140
+ /** @description Permissions for a workflow stage */
1141
+ WorkflowStagePermission: {
1142
+ /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
1143
+ write?: boolean;
1144
+ /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
1145
+ publish?: boolean;
1146
+ };
1147
+ /** @description Permissions for a workflow stage transition */
1148
+ WorkflowStageTransitionPermission: {
1149
+ /** @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. */
1150
+ execute?: boolean;
1151
+ };
998
1152
  };
999
1153
  };
1000
1154
  operations: {};
@@ -1322,7 +1476,7 @@ interface external {
1322
1476
  /** @description The name of the query string parameter */
1323
1477
  name: string;
1324
1478
  /** @description The default value of the query string if it is not provided by an incoming route path */
1325
- value: string;
1479
+ value?: string;
1326
1480
  /** @description Help text for authors who might be setting up a preview value for this query string */
1327
1481
  helpText?: string;
1328
1482
  };
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: {
@@ -588,6 +598,35 @@ interface external {
588
598
  * @enum {string}
589
599
  */
590
600
  syntax: "jptr";
601
+ /**
602
+ * @description The action to take if the dynamic token cannot be resolved
603
+ * - t: TOKEN: Removes the failed dynamic token value, leaving the rest of the property value, if any, intact [default]
604
+ * NOTE: if the _only_ value in the property is a dynamic token, the property value is removed (as with 'p' below)
605
+ * NOTE: if the _failureDefault_ property is also set, that default value will be used instead of removing the token.
606
+ * this only applies when the failureAction is 't' or undefined, the default is otherwise ignored.
607
+ * - p: PROPERTY: Removes the entire property value, including any other dynamic tokens or static values in the property
608
+ * - c: COMPONENT: Removes the whole parent component or block that contains the property.
609
+ * NOTE: If a 'component' failure occurs on the root component of a composition, or on an entry,
610
+ * it is treated as an 'a' failure because removing the root means we must remove all.
611
+ * - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses.
612
+ *
613
+ * @enum {string}
614
+ */
615
+ failureAction?: "t" | "p" | "c" | "a";
616
+ /**
617
+ * @description How to report when the dynamic token cannot be resolved
618
+ * - e: ERROR: Report an error message (this will prevent publishing)
619
+ * - w: WARNING: Report a warning message [default]
620
+ * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
621
+ *
622
+ * @enum {string}
623
+ */
624
+ failureLogLevel?: "e" | "w" | "i";
625
+ /**
626
+ * @description The default value to use if the dynamic token cannot be resolved.
627
+ * This is only used if the failureAction is the default (undefined, or explicitly token).
628
+ */
629
+ failureDefault?: string;
591
630
  };
592
631
  /** @description Defines the shape of a component instance served by the composition API. */
593
632
  ComponentInstance: {
@@ -669,6 +708,14 @@ interface external {
669
708
  _slug?: string | null;
670
709
  /** @description Friendly name of this component. */
671
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;
672
719
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
673
720
  _pattern?: string;
674
721
  /**
@@ -762,7 +809,7 @@ interface external {
762
809
  id: string;
763
810
  /** @description Display name of the data source */
764
811
  displayName: string;
765
- /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
812
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an installed integration) */
766
813
  connectorType: string;
767
814
  /** @description Base resource URL of the data source. No trailing slash. */
768
815
  baseUrl: string;
@@ -995,6 +1042,113 @@ interface external {
995
1042
  /** @description Supported parameter types */
996
1043
  parameterTypes?: string[] | null;
997
1044
  };
1045
+ /** @description Definition of a workflow that can be assigned to entities */
1046
+ WorkflowDefinition: {
1047
+ /**
1048
+ * Format: uuid
1049
+ * @description Unique identifier of the workflow definition
1050
+ */
1051
+ id: string;
1052
+ /** @description Workflow name */
1053
+ name: string;
1054
+ /**
1055
+ * Format: uuid
1056
+ * @description The ID of the initial stage in the stages object.
1057
+ */
1058
+ initialStage: string;
1059
+ /** @description All stages of the workflow */
1060
+ stages: {
1061
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStage"];
1062
+ };
1063
+ /** @description Last modified ISO date string for this definition (ignored for writes) */
1064
+ modified?: string;
1065
+ /** @description Created ISO date string for this definition (ignored for writes) */
1066
+ created?: string;
1067
+ /**
1068
+ * @description Name of the original creator of the workflow.
1069
+ * If undefined, the user has been removed from the team.
1070
+ * Ignored for writes.
1071
+ */
1072
+ createdBy?: string;
1073
+ /**
1074
+ * @description Name of the last modifier of the workflow.
1075
+ * If undefined, the user has been removed from the team.
1076
+ * Ignored for writes.
1077
+ */
1078
+ modifiedBy?: string;
1079
+ };
1080
+ /** @description Definition of a stage in a workflow */
1081
+ WorkflowStage: {
1082
+ /** @description Name of the stage */
1083
+ name: string;
1084
+ /**
1085
+ * @description Defines roles which have permissions to this workflow stage
1086
+ * NOTE: being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
1087
+ * 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
1088
+ * listed here, the stage is read only and publishing is disabled.
1089
+ */
1090
+ permissions: {
1091
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStagePermission"];
1092
+ };
1093
+ /**
1094
+ * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
1095
+ * 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.
1096
+ * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
1097
+ * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1098
+ */
1099
+ autoPublish?: boolean;
1100
+ /**
1101
+ * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
1102
+ * If the entity is not valid, the transition will not be allowed.
1103
+ * NOTE: this is not executed by direct API calls. Only the Uniform UI performs this action.
1104
+ */
1105
+ requireValidity?: boolean;
1106
+ /**
1107
+ * @description Defines transitions to other stages
1108
+ * Every stage must define at least one transition, to avoid creating a workflow that
1109
+ * has a stage that can never be escaped.
1110
+ */
1111
+ transitions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransition"][];
1112
+ /**
1113
+ * @description Icon name for the stage (e.g. 'chevron-double-right-o')
1114
+ * @default chevron-double-right-o
1115
+ */
1116
+ icon?: string;
1117
+ /** @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. */
1118
+ order?: number;
1119
+ };
1120
+ /** @description Definition of a transition from one stage to another in a workflow */
1121
+ WorkflowStageTransition: {
1122
+ /**
1123
+ * Format: uuid
1124
+ * @description The target stage to transition to
1125
+ */
1126
+ to: string;
1127
+ /**
1128
+ * @description Name shown to the user when they execute this transition.
1129
+ * If not provided, a default name will be assigned automatically based on the target stage.
1130
+ */
1131
+ name: string;
1132
+ /**
1133
+ * @description Permissions for the stage transition.
1134
+ * NOTE: Users without membership in any role listed here will be unable to execute the transition, unless they are team admins.
1135
+ */
1136
+ permissions: {
1137
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["WorkflowStageTransitionPermission"];
1138
+ };
1139
+ };
1140
+ /** @description Permissions for a workflow stage */
1141
+ WorkflowStagePermission: {
1142
+ /** @description Allows writing to entities assigned to this stage. When false or unspecified the data is read-only. */
1143
+ write?: boolean;
1144
+ /** @description Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled. */
1145
+ publish?: boolean;
1146
+ };
1147
+ /** @description Permissions for a workflow stage transition */
1148
+ WorkflowStageTransitionPermission: {
1149
+ /** @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. */
1150
+ execute?: boolean;
1151
+ };
998
1152
  };
999
1153
  };
1000
1154
  operations: {};
@@ -1322,7 +1476,7 @@ interface external {
1322
1476
  /** @description The name of the query string parameter */
1323
1477
  name: string;
1324
1478
  /** @description The default value of the query string if it is not provided by an incoming route path */
1325
- value: string;
1479
+ value?: string;
1326
1480
  /** @description Help text for authors who might be setting up a preview value for this query string */
1327
1481
  helpText?: string;
1328
1482
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.134.3-alpha.28+506233b832",
3
+ "version": "19.135.1-alpha.10+261b728b6b",
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.134.3-alpha.28+506233b832"
39
+ "@uniformdev/context": "19.135.1-alpha.10+261b728b6b"
40
40
  },
41
- "gitHead": "506233b8324cbb3d7d6a0ef97b8d5e01b36bfb08"
41
+ "gitHead": "261b728b6bc036ca8260861715632078b3eb27ca"
42
42
  }