@monosmith/plugin-sdk 2.0.0-beta.6 → 2.0.0-beta.7

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monosmith/plugin-sdk",
3
- "version": "2.0.0-beta.6",
3
+ "version": "2.0.0-beta.7",
4
4
  "description": "The TypeScript SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -2044,6 +2044,10 @@ export const protocolSchema = {
2044
2044
  "tag": {
2045
2045
  "type": "string",
2046
2046
  "description": "Tag is the name of the release channel the version belongs to (npm's dist-tag \"beta\"). When set, the plugin publishes under it and leaves the registry's stable pointer where it is, or ignores it when its registry has no such pointer. Only sent to a plugin with the channels capability."
2047
+ },
2048
+ "propagationWait": {
2049
+ "type": "string",
2050
+ "description": "PropagationWait is the longest time a plugin waits, before it moves a dist-tag, for the packages of the release to be fetchable from the registry: a duration such as \"15m\", \"0\" to not wait. Empty means the default. Only npm has such a wait."
2047
2051
  }
2048
2052
  },
2049
2053
  "required": [
@@ -2071,6 +2075,13 @@ export const protocolSchema = {
2071
2075
  },
2072
2076
  "description": "Notes are things the person must know about a publish that succeeded, such as a dist-tag that was not moved; the host prints them and the report keeps them."
2073
2077
  },
2078
+ "pendingTags": {
2079
+ "type": "array",
2080
+ "items": {
2081
+ "type": "string"
2082
+ },
2083
+ "description": "PendingTags are the exact commands that move the dist-tags the publish did not move, because the packages the release needs were not fetchable yet. The release then ends with a warning, never silently."
2084
+ },
2074
2085
  "assets": {
2075
2086
  "type": "array",
2076
2087
  "items": {
@@ -1091,6 +1091,12 @@ export interface PublishParams {
1091
1091
  * capability.
1092
1092
  */
1093
1093
  tag?: string;
1094
+ /**
1095
+ * PropagationWait is the longest time a plugin waits, before it moves a dist-tag, for the
1096
+ * packages of the release to be fetchable from the registry: a duration such as "15m", "0" to not
1097
+ * wait. Empty means the default. Only npm has such a wait.
1098
+ */
1099
+ propagationWait?: string;
1094
1100
  }
1095
1101
  /**
1096
1102
  * PublishResult reports what happened. Skipped with a reason is a success: an already-published
@@ -1105,6 +1111,12 @@ export interface PublishResult {
1105
1111
  * was not moved; the host prints them and the report keeps them.
1106
1112
  */
1107
1113
  notes?: string[];
1114
+ /**
1115
+ * PendingTags are the exact commands that move the dist-tags the publish did not move, because
1116
+ * the packages the release needs were not fetchable yet. The release then ends with a warning,
1117
+ * never silently.
1118
+ */
1119
+ pendingTags?: string[];
1108
1120
  /**
1109
1121
  * Assets are the workspace-relative files built for the release, in upload order; in a dry run,
1110
1122
  * the files that would be built.