@minecraft/markup-generators-plugin 1.1.1 → 1.2.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.
Files changed (7) hide show
  1. package/CHANGELOG.json +22 -1
  2. package/CHANGELOG.md +11 -2
  3. package/package.json +3 -3
  4. package/templates/msdocs/script/function.mustache +9 -3
  5. package/templates/msdocs/script/property.mustache +16 -13
  6. package/templates/tsdef/function.mustache +15 -3
  7. package/templates/tsdef/property.mustache +17 -13
package/CHANGELOG.json CHANGED
@@ -2,7 +2,28 @@
2
2
  "name": "@minecraft/markup-generators-plugin",
3
3
  "entries": [
4
4
  {
5
- "date": "Mon, 29 Sep 2025 17:42:07 GMT",
5
+ "date": "Tue, 13 Jan 2026 21:57:09 GMT",
6
+ "version": "1.2.0",
7
+ "tag": "@minecraft/markup-generators-plugin_v1.2.0",
8
+ "comments": {
9
+ "minor": [
10
+ {
11
+ "author": "agriffin@microsoft.com",
12
+ "package": "@minecraft/markup-generators-plugin",
13
+ "commit": "e88bbe1ca158509f1ec32b2e86d48a0b1819b7e6",
14
+ "comment": "Added closure execution privileges for properties, returns, and parameters. Also renamed privileges."
15
+ },
16
+ {
17
+ "author": "beachball",
18
+ "package": "@minecraft/markup-generators-plugin",
19
+ "comment": "Bump @minecraft/api-docs-generator to v1.3.0",
20
+ "commit": "not available"
21
+ }
22
+ ]
23
+ }
24
+ },
25
+ {
26
+ "date": "Mon, 29 Sep 2025 17:42:55 GMT",
6
27
  "version": "1.1.1",
7
28
  "tag": "@minecraft/markup-generators-plugin_v1.1.1",
8
29
  "comments": {
package/CHANGELOG.md CHANGED
@@ -1,12 +1,21 @@
1
1
  # Change Log - @minecraft/markup-generators-plugin
2
2
 
3
- <!-- This log was last generated on Mon, 29 Sep 2025 17:42:07 GMT and should not be manually modified. -->
3
+ <!-- This log was last generated on Tue, 13 Jan 2026 21:57:09 GMT and should not be manually modified. -->
4
4
 
5
5
  <!-- Start content -->
6
6
 
7
+ ## 1.2.0
8
+
9
+ Tue, 13 Jan 2026 21:57:09 GMT
10
+
11
+ ### Minor changes
12
+
13
+ - Added closure execution privileges for properties, returns, and parameters. Also renamed privileges. (agriffin@microsoft.com)
14
+ - Bump @minecraft/api-docs-generator to v1.3.0
15
+
7
16
  ## 1.1.1
8
17
 
9
- Mon, 29 Sep 2025 17:42:07 GMT
18
+ Mon, 29 Sep 2025 17:42:55 GMT
10
19
 
11
20
  ### Patches
12
21
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/markup-generators-plugin",
3
- "version": "1.1.1",
3
+ "version": "1.2.0",
4
4
  "description": "Plugin for @minecraft/api-docs-generator containing core markup generators and template files",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -40,7 +40,7 @@
40
40
  "CHANGELOG.*"
41
41
  ],
42
42
  "devDependencies": {
43
- "@minecraft/api-docs-generator": "^1.2.6",
43
+ "@minecraft/api-docs-generator": "^1.3.0",
44
44
  "@minecraft/core-build-tasks": "*",
45
45
  "@types/mustache": "^4.2.2",
46
46
  "@types/node": "^22.0.0",
@@ -61,6 +61,6 @@
61
61
  "typescript": "~5.6.0"
62
62
  },
63
63
  "peerDependencies": {
64
- "@minecraft/api-docs-generator": "^1.2.6"
64
+ "@minecraft/api-docs-generator": "^1.3.0"
65
65
  }
66
66
  }
package/templates/msdocs/script/function.mustache CHANGED
@@ -26,12 +26,18 @@
26
26
 
27
27
  {{{.}}}
28
28
  {{/argument_description_md}}
29
+ {{#has_closure_privilege_type_comments}}
30
+ This closure is called with {{closure_privilege_type_name}} privilege.
31
+ {{/has_closure_privilege_type_comments}}
29
32
  {{/arguments}}
30
33
  {{/arguments.length}}
31
34
  {{#return_type}}
32
35
  {{^is_void_return}}
33
36
 
34
37
  **Returns** {{> type_with_links}}{{#is_optional}} | *undefined*{{/is_optional}}{{#returns_description_md}} - {{{returns_description_md}}}{{/returns_description_md}}
38
+ {{#return_type_has_closure_privilege_type_comments}}
39
+ The returned closure is called with {{return_type_closure_privilege_type_name}} privilege.
40
+ {{/return_type_has_closure_privilege_type_comments}}
35
41
  {{/is_void_return}}
36
42
  {{#is_prerelease}}
37
43
 
@@ -58,9 +64,9 @@
58
64
  {{#msdocs_has_comments}}
59
65
 
60
66
  Notes:
61
- {{#call_disallowed_in_read_only}}
62
- - This function can't be called in read-only mode.
63
- {{/call_disallowed_in_read_only}}
67
+ {{#call_disallowed_in_restricted_execution}}
68
+ - This function can't be called in restricted-execution mode.
69
+ {{/call_disallowed_in_restricted_execution}}
64
70
  {{#call_allowed_in_early_execution}}
65
71
  - This function can be called in early-execution mode.
66
72
  {{/call_allowed_in_early_execution}}
package/templates/msdocs/script/property.mustache CHANGED
@@ -26,19 +26,19 @@ Notes:
26
26
  - This property defaults to `{{> value}}` when undefined.
27
27
  {{/default_value}}
28
28
  {{/has_defaults}}
29
- {{#set_disallowed_in_read_only}}
30
- {{#get_disallowed_in_read_only}}
31
- - This property can't be used in read-only mode.
32
- {{/get_disallowed_in_read_only}}
33
- {{^get_disallowed_in_read_only}}
34
- - This property can't be edited in read-only mode.
35
- {{/get_disallowed_in_read_only}}
36
- {{/set_disallowed_in_read_only}}
37
- {{^set_disallowed_in_read_only}}
38
- {{#get_disallowed_in_read_only}}
39
- - This property can't be read in read-only mode.
40
- {{/get_disallowed_in_read_only}}
41
- {{/set_disallowed_in_read_only}}
29
+ {{#set_disallowed_in_restricted_execution}}
30
+ {{#get_disallowed_in_restricted_execution}}
31
+ - This property can't be used in restricted-execution mode.
32
+ {{/get_disallowed_in_restricted_execution}}
33
+ {{^get_disallowed_in_restricted_execution}}
34
+ - This property can't be edited in restricted-execution mode.
35
+ {{/get_disallowed_in_restricted_execution}}
36
+ {{/set_disallowed_in_restricted_execution}}
37
+ {{^set_disallowed_in_restricted_execution}}
38
+ {{#get_disallowed_in_restricted_execution}}
39
+ - This property can't be read in restricted-execution mode.
40
+ {{/get_disallowed_in_restricted_execution}}
41
+ {{/set_disallowed_in_restricted_execution}}
42
42
  {{#set_allowed_in_early_execution}}
43
43
  {{#get_allowed_in_early_execution}}
44
44
  - This property can be used in early-execution mode.
@@ -71,6 +71,9 @@ Notes:
71
71
  {{/throws_description_md.length}}
72
72
  {{/error_types.length}}
73
73
  {{/type}}
74
+ {{#has_closure_privilege_type_comments}}
75
+ - This closure is called with {{closure_privilege_type_name}} privilege.
76
+ {{/has_closure_privilege_type_comments}}
74
77
  {{/msdocs_has_comments}}
75
78
  {{#examples.length}}
76
79
 
package/templates/tsdef/function.mustache CHANGED
@@ -23,10 +23,10 @@
23
23
  {{/function_description_ts}}
24
24
  *
25
25
  {{/function_description_ts.length}}
26
- {{#call_disallowed_in_read_only}}
27
- * This function can't be called in read-only mode.
26
+ {{#call_disallowed_in_restricted_execution}}
27
+ * This function can't be called in restricted-execution mode.
28
28
  *
29
- {{/call_disallowed_in_read_only}}
29
+ {{/call_disallowed_in_restricted_execution}}
30
30
  {{#call_allowed_in_early_execution}}
31
31
  * This function can be called in early-execution mode.
32
32
  *
@@ -40,6 +40,9 @@
40
40
  * {{{.}}}
41
41
  {{/argument_description_ts}}
42
42
  {{/argument_description_ts.length}}
43
+ {{#has_closure_privilege_type_comments}}
44
+ * This closure is called with {{closure_privilege_type_name}} privilege.
45
+ {{/has_closure_privilege_type_comments}}
43
46
  {{#has_defaults}}
44
47
  {{#details.default_value}}
45
48
  * Defaults to: {{> value}}
@@ -52,6 +55,15 @@
52
55
  {{#returns_description_ts}}
53
56
  * {{{.}}}
54
57
  {{/returns_description_ts}}
58
+ {{#return_type_has_closure_privilege_type_comments}}
59
+ * Closure that is called with {{return_type_closure_privilege_type_name}} privilege.
60
+ {{/return_type_has_closure_privilege_type_comments}}
61
+ {{/returns_description_ts.length}}
62
+ {{^returns_description_ts.length}}
63
+ {{#return_type_has_closure_privilege_type_comments}}
64
+ * @returns
65
+ * Closure that is called with {{return_type_closure_privilege_type_name}} privilege.
66
+ {{/return_type_has_closure_privilege_type_comments}}
55
67
  {{/returns_description_ts.length}}
56
68
  {{#has_runtime_conditions}}
57
69
  *
package/templates/tsdef/property.mustache CHANGED
@@ -23,22 +23,26 @@
23
23
  {{/property_description_ts}}
24
24
  *
25
25
  {{/property_description_ts.length}}
26
- {{#set_disallowed_in_read_only}}
27
- {{#get_disallowed_in_read_only}}
28
- * This property can't be used in read-only mode.
26
+ {{#has_closure_privilege_type_comments}}
27
+ * This closure is called with {{closure_privilege_type_name}} privilege.
29
28
  *
30
- {{/get_disallowed_in_read_only}}
31
- {{^get_disallowed_in_read_only}}
32
- * This property can't be edited in read-only mode.
29
+ {{/has_closure_privilege_type_comments}}
30
+ {{#set_disallowed_in_restricted_execution}}
31
+ {{#get_disallowed_in_restricted_execution}}
32
+ * This property can't be used in restricted-execution mode.
33
33
  *
34
- {{/get_disallowed_in_read_only}}
35
- {{/set_disallowed_in_read_only}}
36
- {{^set_disallowed_in_read_only}}
37
- {{#get_disallowed_in_read_only}}
38
- * This property can't be read in read-only mode.
34
+ {{/get_disallowed_in_restricted_execution}}
35
+ {{^get_disallowed_in_restricted_execution}}
36
+ * This property can't be edited in restricted-execution mode.
39
37
  *
40
- {{/get_disallowed_in_read_only}}
41
- {{/set_disallowed_in_read_only}}
38
+ {{/get_disallowed_in_restricted_execution}}
39
+ {{/set_disallowed_in_restricted_execution}}
40
+ {{^set_disallowed_in_restricted_execution}}
41
+ {{#get_disallowed_in_restricted_execution}}
42
+ * This property can't be read in restricted-execution mode.
43
+ *
44
+ {{/get_disallowed_in_restricted_execution}}
45
+ {{/set_disallowed_in_restricted_execution}}
42
46
  {{#set_allowed_in_early_execution}}
43
47
  {{#get_allowed_in_early_execution}}
44
48
  * This property can be used in early-execution mode.